typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Read this!

These files are not meant to be edited by hand. If you need to make modifications, the respective files should be changed within the repository's top-level src directory. Running jake LKG will then appropriately update the files in this directory.

Index

External modules

"node_modules/typescript/lib/typescript.d"

"node_modules/typescript/lib/typescript.d":

ts

ts:

HighlightSpanKind

HighlightSpanKind:

definition

definition: string

none

none: string

reference

reference: string

writtenReference

writtenReference: string

ScriptElementKind

ScriptElementKind:

alias

alias: string

callSignatureElement

callSignatureElement: string

classElement

classElement: string

constElement

constElement: string

constructSignatureElement

constructSignatureElement: string

constructorImplementationElement

constructorImplementationElement: string

enumElement

enumElement: string

functionElement

functionElement: string

indexSignatureElement

indexSignatureElement: string

interfaceElement

interfaceElement: string

keyword

keyword: string

label

label: string

letElement

letElement: string

localClassElement

localClassElement: string

localFunctionElement

localFunctionElement: string

localVariableElement

localVariableElement: string

memberFunctionElement

memberFunctionElement: string

memberGetAccessorElement

memberGetAccessorElement: string

memberSetAccessorElement

memberSetAccessorElement: string

memberVariableElement

memberVariableElement: string

moduleElement

moduleElement: string

parameterElement

parameterElement: string

primitiveType

primitiveType: string

scriptElement

scriptElement: string

typeElement

typeElement: string

typeParameterElement

typeParameterElement: string

unknown

unknown: string

variableElement

variableElement: string

warning

warning: string

ScriptElementKindModifier

ScriptElementKindModifier:

abstractModifier

abstractModifier: string

ambientModifier

ambientModifier: string

exportedModifier

exportedModifier: string

none

none: string

privateMemberModifier

privateMemberModifier: string

protectedMemberModifier

protectedMemberModifier: string

publicMemberModifier

publicMemberModifier: string

staticModifier

staticModifier: string

ScriptSnapshot

ScriptSnapshot:

fromString

  • Parameters

    • text: string

    Returns IScriptSnapshot

ClassificationType

ClassificationType:

className

className:

comment

comment:

docCommentTagName

docCommentTagName:

enumName

enumName:

identifier

identifier:

interfaceName

interfaceName:

jsxAttribute

jsxAttribute:

jsxAttributeStringLiteralValue

jsxAttributeStringLiteralValue:

jsxCloseTagName

jsxCloseTagName:

jsxOpenTagName

jsxOpenTagName:

jsxSelfClosingTagName

jsxSelfClosingTagName:

jsxText

jsxText:

keyword

keyword:

moduleName

moduleName:

numericLiteral

numericLiteral:

operator

operator:

parameterName

parameterName:

punctuation

punctuation:

regularExpressionLiteral

regularExpressionLiteral:

stringLiteral

stringLiteral:

text

text:

typeAliasName

typeAliasName:

typeParameterName

typeParameterName:

whiteSpace

whiteSpace:

DiagnosticCategory

DiagnosticCategory:

Error

Error:

Message

Message:

Warning

Warning:

EndOfLineState

EndOfLineState:

InDoubleQuoteStringLiteral

InDoubleQuoteStringLiteral:

InMultiLineCommentTrivia

InMultiLineCommentTrivia:

InSingleQuoteStringLiteral

InSingleQuoteStringLiteral:

InTemplateHeadOrNoSubstitutionTemplate

InTemplateHeadOrNoSubstitutionTemplate:

InTemplateMiddleOrTail

InTemplateMiddleOrTail:

InTemplateSubstitutionPosition

InTemplateSubstitutionPosition:

None

None:

ExitStatus

ExitStatus:

Return code used by getEmitOutput function to indicate status of the function

DiagnosticsPresent_OutputsGenerated

DiagnosticsPresent_OutputsGenerated:

DiagnosticsPresent_OutputsSkipped

DiagnosticsPresent_OutputsSkipped:

Success

Success:

IndentStyle

IndentStyle:

Block

Block:

None

None:

Smart

Smart:

IndexKind

IndexKind:

Number

Number:

String

String:

JsxEmit

JsxEmit:

None

None:

Preserve

Preserve:

React

React:

JsxFlags

JsxFlags:

IntrinsicElement

IntrinsicElement:

IntrinsicIndexedElement

IntrinsicIndexedElement:

An element inferred from the string index signature of the JSX.IntrinsicElements interface

IntrinsicNamedElement

IntrinsicNamedElement:

An element from a named property of the JSX.IntrinsicElements interface

None

None:

UnknownElement

UnknownElement:

Element resolution failed

ValueElement

ValueElement:

An element backed by a class, class-like, or function value

LanguageVariant

LanguageVariant:

JSX

JSX:

Standard

Standard:

ModuleKind

ModuleKind:

AMD

AMD:

CommonJS

CommonJS:

ES2015

ES2015:

ES6

ES6:

None

None:

System

System:

UMD

UMD:

ModuleResolutionKind

ModuleResolutionKind:

Classic

Classic:

NodeJs

NodeJs:

NewLineKind

NewLineKind:

CarriageReturnLineFeed

CarriageReturnLineFeed:

LineFeed

LineFeed:

NodeFlags

NodeFlags:

Abstract

Abstract:

AccessibilityModifier

AccessibilityModifier:

Ambient

Ambient:

Async

Async:

BlockScoped

BlockScoped:

Const

Const:

ContainsThis

ContainsThis:

DeclarationFile

DeclarationFile:

Default

Default:

EmitHelperFlags

EmitHelperFlags:

Export

Export:

ExportContext

ExportContext:

GlobalAugmentation

GlobalAugmentation:

HasAsyncFunctions

HasAsyncFunctions:

HasClassExtends

HasClassExtends:

HasDecorators

HasDecorators:

HasExplicitReturn

HasExplicitReturn:

HasImplicitReturn

HasImplicitReturn:

HasParamDecorators

HasParamDecorators:

Let

Let:

Modifier

Modifier:

MultiLine

MultiLine:

Namespace

Namespace:

None

None:

OctalLiteral

OctalLiteral:

Private

Private:

Protected

Protected:

Public

Public:

ReachabilityCheckFlags

ReachabilityCheckFlags:

Static

Static:

Synthetic

Synthetic:

OutputFileType

OutputFileType:

Declaration

Declaration:

JavaScript

JavaScript:

SourceMap

SourceMap:

ScriptTarget

ScriptTarget:

ES2015

ES2015:

ES3

ES3:

ES5

ES5:

ES6

ES6:

Latest

Latest:

SignatureKind

SignatureKind:

Call

Call:

Construct

Construct:

SymbolDisplayPartKind

SymbolDisplayPartKind:

aliasName

aliasName:

className

className:

enumMemberName

enumMemberName:

enumName

enumName:

fieldName

fieldName:

functionName

functionName:

interfaceName

interfaceName:

keyword

keyword:

lineBreak

lineBreak:

localName

localName:

methodName

methodName:

moduleName

moduleName:

numericLiteral

numericLiteral:

operator

operator:

parameterName

parameterName:

propertyName

propertyName:

punctuation

punctuation:

regularExpressionLiteral

regularExpressionLiteral:

space

space:

stringLiteral

stringLiteral:

text

text:

typeParameterName

typeParameterName:

SymbolFlags

SymbolFlags:

Accessor

Accessor:

Alias

Alias:

AliasExcludes

AliasExcludes:

BlockScoped

BlockScoped:

BlockScopedVariable

BlockScopedVariable:

BlockScopedVariableExcludes

BlockScopedVariableExcludes:

Class

Class:

ClassExcludes

ClassExcludes:

ConstEnum

ConstEnum:

ConstEnumExcludes

ConstEnumExcludes:

Constructor

Constructor:

Enum

Enum:

EnumMember

EnumMember:

EnumMemberExcludes

EnumMemberExcludes:

Export

Export:

ExportHasLocal

ExportHasLocal:

ExportNamespace

ExportNamespace:

ExportStar

ExportStar:

ExportType

ExportType:

ExportValue

ExportValue:

Function

Function:

FunctionExcludes

FunctionExcludes:

FunctionScopedVariable

FunctionScopedVariable:

FunctionScopedVariableExcludes

FunctionScopedVariableExcludes:

GetAccessor

GetAccessor:

GetAccessorExcludes

GetAccessorExcludes:

HasExports

HasExports:

HasMembers

HasMembers:

Instantiated

Instantiated:

Interface

Interface:

InterfaceExcludes

InterfaceExcludes:

Merged

Merged:

Method

Method:

MethodExcludes

MethodExcludes:

Module

Module:

ModuleMember

ModuleMember:

Namespace

Namespace:

NamespaceModule

NamespaceModule:

NamespaceModuleExcludes

NamespaceModuleExcludes:

None

None:

ObjectLiteral

ObjectLiteral:

Optional

Optional:

ParameterExcludes

ParameterExcludes:

Property

Property:

PropertyExcludes

PropertyExcludes:

PropertyOrAccessor

PropertyOrAccessor:

Prototype

Prototype:

RegularEnum

RegularEnum:

RegularEnumExcludes

RegularEnumExcludes:

SetAccessor

SetAccessor:

SetAccessorExcludes

SetAccessorExcludes:

Signature

Signature:

SyntheticProperty

SyntheticProperty:

Transient

Transient:

Type

Type:

TypeAlias

TypeAlias:

TypeAliasExcludes

TypeAliasExcludes:

TypeLiteral

TypeLiteral:

TypeParameter

TypeParameter:

TypeParameterExcludes

TypeParameterExcludes:

Value

Value:

ValueModule

ValueModule:

ValueModuleExcludes

ValueModuleExcludes:

Variable

Variable:

SymbolFormatFlags

SymbolFormatFlags:

None

None:

UseOnlyExternalAliasing

UseOnlyExternalAliasing:

WriteTypeParametersOrArguments

WriteTypeParametersOrArguments:

SyntaxKind

SyntaxKind:

AbstractKeyword

AbstractKeyword:

AmpersandAmpersandToken

AmpersandAmpersandToken:

AmpersandEqualsToken

AmpersandEqualsToken:

AmpersandToken

AmpersandToken:

AnyKeyword

AnyKeyword:

ArrayBindingPattern

ArrayBindingPattern:

ArrayLiteralExpression

ArrayLiteralExpression:

ArrayType

ArrayType:

ArrowFunction

ArrowFunction:

AsExpression

AsExpression:

AsKeyword

AsKeyword:

AsteriskAsteriskEqualsToken

AsteriskAsteriskEqualsToken:

AsteriskAsteriskToken

AsteriskAsteriskToken:

AsteriskEqualsToken

AsteriskEqualsToken:

AsteriskToken

AsteriskToken:

AsyncKeyword

AsyncKeyword:

AtToken

AtToken:

AwaitExpression

AwaitExpression:

AwaitKeyword

AwaitKeyword:

BarBarToken

BarBarToken:

BarEqualsToken

BarEqualsToken:

BarToken

BarToken:

BinaryExpression

BinaryExpression:

BindingElement

BindingElement:

Block

Block:

BooleanKeyword

BooleanKeyword:

BreakKeyword

BreakKeyword:

BreakStatement

BreakStatement:

CallExpression

CallExpression:

CallSignature

CallSignature:

CaretEqualsToken

CaretEqualsToken:

CaretToken

CaretToken:

CaseBlock

CaseBlock:

CaseClause

CaseClause:

CaseKeyword

CaseKeyword:

CatchClause

CatchClause:

CatchKeyword

CatchKeyword:

ClassDeclaration

ClassDeclaration:

ClassExpression

ClassExpression:

ClassKeyword

ClassKeyword:

CloseBraceToken

CloseBraceToken:

CloseBracketToken

CloseBracketToken:

CloseParenToken

CloseParenToken:

ColonToken

ColonToken:

CommaToken

CommaToken:

ComputedPropertyName

ComputedPropertyName:

ConditionalExpression

ConditionalExpression:

ConflictMarkerTrivia

ConflictMarkerTrivia:

ConstKeyword

ConstKeyword:

ConstructSignature

ConstructSignature:

Constructor

Constructor:

ConstructorKeyword

ConstructorKeyword:

ConstructorType

ConstructorType:

ContinueKeyword

ContinueKeyword:

ContinueStatement

ContinueStatement:

Count

Count:

DebuggerKeyword

DebuggerKeyword:

DebuggerStatement

DebuggerStatement:

DeclareKeyword

DeclareKeyword:

Decorator

Decorator:

DefaultClause

DefaultClause:

DefaultKeyword

DefaultKeyword:

DeleteExpression

DeleteExpression:

DeleteKeyword

DeleteKeyword:

DoKeyword

DoKeyword:

DoStatement

DoStatement:

DotDotDotToken

DotDotDotToken:

DotToken

DotToken:

ElementAccessExpression

ElementAccessExpression:

ElseKeyword

ElseKeyword:

EmptyStatement

EmptyStatement:

EndOfFileToken

EndOfFileToken:

EnumDeclaration

EnumDeclaration:

EnumKeyword

EnumKeyword:

EnumMember

EnumMember:

EqualsEqualsEqualsToken

EqualsEqualsEqualsToken:

EqualsEqualsToken

EqualsEqualsToken:

EqualsGreaterThanToken

EqualsGreaterThanToken:

EqualsToken

EqualsToken:

ExclamationEqualsEqualsToken

ExclamationEqualsEqualsToken:

ExclamationEqualsToken

ExclamationEqualsToken:

ExclamationToken

ExclamationToken:

ExportAssignment

ExportAssignment:

ExportDeclaration

ExportDeclaration:

ExportKeyword

ExportKeyword:

ExportSpecifier

ExportSpecifier:

ExpressionStatement

ExpressionStatement:

ExpressionWithTypeArguments

ExpressionWithTypeArguments:

ExtendsKeyword

ExtendsKeyword:

ExternalModuleReference

ExternalModuleReference:

FalseKeyword

FalseKeyword:

FinallyKeyword

FinallyKeyword:

FirstAssignment

FirstAssignment:

FirstBinaryOperator

FirstBinaryOperator:

FirstFutureReservedWord

FirstFutureReservedWord:

FirstKeyword

FirstKeyword:

FirstLiteralToken

FirstLiteralToken:

FirstNode

FirstNode:

FirstPunctuation

FirstPunctuation:

FirstReservedWord

FirstReservedWord:

FirstTemplateToken

FirstTemplateToken:

FirstToken

FirstToken:

FirstTriviaToken

FirstTriviaToken:

FirstTypeNode

FirstTypeNode:

ForInStatement

ForInStatement:

ForKeyword

ForKeyword:

ForOfStatement

ForOfStatement:

ForStatement

ForStatement:

FromKeyword

FromKeyword:

FunctionDeclaration

FunctionDeclaration:

FunctionExpression

FunctionExpression:

FunctionKeyword

FunctionKeyword:

FunctionType

FunctionType:

GetAccessor

GetAccessor:

GetKeyword

GetKeyword:

GlobalKeyword

GlobalKeyword:

GreaterThanEqualsToken

GreaterThanEqualsToken:

GreaterThanGreaterThanEqualsToken

GreaterThanGreaterThanEqualsToken:

GreaterThanGreaterThanGreaterThanEqualsToken

GreaterThanGreaterThanGreaterThanEqualsToken:

GreaterThanGreaterThanGreaterThanToken

GreaterThanGreaterThanGreaterThanToken:

GreaterThanGreaterThanToken

GreaterThanGreaterThanToken:

GreaterThanToken

GreaterThanToken:

HeritageClause

HeritageClause:

Identifier

Identifier:

IfKeyword

IfKeyword:

IfStatement

IfStatement:

ImplementsKeyword

ImplementsKeyword:

ImportClause

ImportClause:

ImportDeclaration

ImportDeclaration:

ImportEqualsDeclaration

ImportEqualsDeclaration:

ImportKeyword

ImportKeyword:

ImportSpecifier

ImportSpecifier:

InKeyword

InKeyword:

IndexSignature

IndexSignature:

InstanceOfKeyword

InstanceOfKeyword:

InterfaceDeclaration

InterfaceDeclaration:

InterfaceKeyword

InterfaceKeyword:

IntersectionType

IntersectionType:

IsKeyword

IsKeyword:

JSDocAllType

JSDocAllType:

JSDocArrayType

JSDocArrayType:

JSDocComment

JSDocComment:

JSDocConstructorType

JSDocConstructorType:

JSDocFunctionType

JSDocFunctionType:

JSDocNonNullableType

JSDocNonNullableType:

JSDocNullableType

JSDocNullableType:

JSDocOptionalType

JSDocOptionalType:

JSDocParameterTag

JSDocParameterTag:

JSDocRecordMember

JSDocRecordMember:

JSDocRecordType

JSDocRecordType:

JSDocReturnTag

JSDocReturnTag:

JSDocTag

JSDocTag:

JSDocTemplateTag

JSDocTemplateTag:

JSDocThisType

JSDocThisType:

JSDocTupleType

JSDocTupleType:

JSDocTypeExpression

JSDocTypeExpression:

JSDocTypeReference

JSDocTypeReference:

JSDocTypeTag

JSDocTypeTag:

JSDocUnionType

JSDocUnionType:

JSDocUnknownType

JSDocUnknownType:

JSDocVariadicType

JSDocVariadicType:

JsxAttribute

JsxAttribute:

JsxClosingElement

JsxClosingElement:

JsxElement

JsxElement:

JsxExpression

JsxExpression:

JsxOpeningElement

JsxOpeningElement:

JsxSelfClosingElement

JsxSelfClosingElement:

JsxSpreadAttribute

JsxSpreadAttribute:

JsxText

JsxText:

LabeledStatement

LabeledStatement:

LastAssignment

LastAssignment:

LastBinaryOperator

LastBinaryOperator:

LastFutureReservedWord

LastFutureReservedWord:

LastKeyword

LastKeyword:

LastLiteralToken

LastLiteralToken:

LastPunctuation

LastPunctuation:

LastReservedWord

LastReservedWord:

LastTemplateToken

LastTemplateToken:

LastToken

LastToken:

LastTriviaToken

LastTriviaToken:

LastTypeNode

LastTypeNode:

LessThanEqualsToken

LessThanEqualsToken:

LessThanLessThanEqualsToken

LessThanLessThanEqualsToken:

LessThanLessThanToken

LessThanLessThanToken:

LessThanSlashToken

LessThanSlashToken:

LessThanToken

LessThanToken:

LetKeyword

LetKeyword:

MethodDeclaration

MethodDeclaration:

MethodSignature

MethodSignature:

MinusEqualsToken

MinusEqualsToken:

MinusMinusToken

MinusMinusToken:

MinusToken

MinusToken:

MissingDeclaration

MissingDeclaration:

ModuleBlock

ModuleBlock:

ModuleDeclaration

ModuleDeclaration:

ModuleKeyword

ModuleKeyword:

MultiLineCommentTrivia

MultiLineCommentTrivia:

NamedExports

NamedExports:

NamedImports

NamedImports:

NamespaceImport

NamespaceImport:

NamespaceKeyword

NamespaceKeyword:

NewExpression

NewExpression:

NewKeyword

NewKeyword:

NewLineTrivia

NewLineTrivia:

NoSubstitutionTemplateLiteral

NoSubstitutionTemplateLiteral:

NullKeyword

NullKeyword:

NumberKeyword

NumberKeyword:

NumericLiteral

NumericLiteral:

ObjectBindingPattern

ObjectBindingPattern:

ObjectLiteralExpression

ObjectLiteralExpression:

OfKeyword

OfKeyword:

OmittedExpression

OmittedExpression:

OpenBraceToken

OpenBraceToken:

OpenBracketToken

OpenBracketToken:

OpenParenToken

OpenParenToken:

PackageKeyword

PackageKeyword:

Parameter

Parameter:

ParenthesizedExpression

ParenthesizedExpression:

ParenthesizedType

ParenthesizedType:

PercentEqualsToken

PercentEqualsToken:

PercentToken

PercentToken:

PlusEqualsToken

PlusEqualsToken:

PlusPlusToken

PlusPlusToken:

PlusToken

PlusToken:

PostfixUnaryExpression

PostfixUnaryExpression:

PrefixUnaryExpression

PrefixUnaryExpression:

PrivateKeyword

PrivateKeyword:

PropertyAccessExpression

PropertyAccessExpression:

PropertyAssignment

PropertyAssignment:

PropertyDeclaration

PropertyDeclaration:

PropertySignature

PropertySignature:

ProtectedKeyword

ProtectedKeyword:

PublicKeyword

PublicKeyword:

QualifiedName

QualifiedName:

QuestionToken

QuestionToken:

RegularExpressionLiteral

RegularExpressionLiteral:

RequireKeyword

RequireKeyword:

ReturnKeyword

ReturnKeyword:

ReturnStatement

ReturnStatement:

SemicolonClassElement

SemicolonClassElement:

SemicolonToken

SemicolonToken:

SetAccessor

SetAccessor:

SetKeyword

SetKeyword:

ShebangTrivia

ShebangTrivia:

ShorthandPropertyAssignment

ShorthandPropertyAssignment:

SingleLineCommentTrivia

SingleLineCommentTrivia:

SlashEqualsToken

SlashEqualsToken:

SlashToken

SlashToken:

SourceFile

SourceFile:

SpreadElementExpression

SpreadElementExpression:

StaticKeyword

StaticKeyword:

StringKeyword

StringKeyword:

StringLiteral

StringLiteral:

StringLiteralType

StringLiteralType:

SuperKeyword

SuperKeyword:

SwitchKeyword

SwitchKeyword:

SwitchStatement

SwitchStatement:

SymbolKeyword

SymbolKeyword:

SyntaxList

SyntaxList:

TaggedTemplateExpression

TaggedTemplateExpression:

TemplateExpression

TemplateExpression:

TemplateHead

TemplateHead:

TemplateMiddle

TemplateMiddle:

TemplateSpan

TemplateSpan:

TemplateTail

TemplateTail:

ThisKeyword

ThisKeyword:

ThisType

ThisType:

ThrowKeyword

ThrowKeyword:

ThrowStatement

ThrowStatement:

TildeToken

TildeToken:

TrueKeyword

TrueKeyword:

TryKeyword

TryKeyword:

TryStatement

TryStatement:

TupleType

TupleType:

TypeAliasDeclaration

TypeAliasDeclaration:

TypeAssertionExpression

TypeAssertionExpression:

TypeKeyword

TypeKeyword:

TypeLiteral

TypeLiteral:

TypeOfExpression

TypeOfExpression:

TypeOfKeyword

TypeOfKeyword:

TypeParameter

TypeParameter:

TypePredicate

TypePredicate:

TypeQuery

TypeQuery:

TypeReference

TypeReference:

UnionType

UnionType:

Unknown

Unknown:

VarKeyword

VarKeyword:

VariableDeclaration

VariableDeclaration:

VariableDeclarationList

VariableDeclarationList:

VariableStatement

VariableStatement:

VoidExpression

VoidExpression:

VoidKeyword

VoidKeyword:

WhileKeyword

WhileKeyword:

WhileStatement

WhileStatement:

WhitespaceTrivia

WhitespaceTrivia:

WithKeyword

WithKeyword:

WithStatement

WithStatement:

YieldExpression

YieldExpression:

YieldKeyword

YieldKeyword:

TokenClass

TokenClass:

Comment

Comment:

Identifier

Identifier:

Keyword

Keyword:

NumberLiteral

NumberLiteral:

Operator

Operator:

Punctuation

Punctuation:

RegExpLiteral

RegExpLiteral:

StringLiteral

StringLiteral:

Whitespace

Whitespace:

TypeFlags

TypeFlags:

Anonymous

Anonymous:

Any

Any:

Boolean

Boolean:

Class

Class:

ESSymbol

ESSymbol:

Enum

Enum:

Instantiated

Instantiated:

Interface

Interface:

Intersection

Intersection:

Null

Null:

Number

Number:

NumberLike

NumberLike:

ObjectLiteral

ObjectLiteral:

ObjectLiteralPatternWithComputedProperties

ObjectLiteralPatternWithComputedProperties:

ObjectType

ObjectType:

Reference

Reference:

String

String:

StringLike

StringLike:

StringLiteral

StringLiteral:

StructuredType

StructuredType:

ThisType

ThisType:

Tuple

Tuple:

TypeParameter

TypeParameter:

Undefined

Undefined:

Union

Union:

UnionOrIntersection

UnionOrIntersection:

Void

Void:

TypeFormatFlags

TypeFormatFlags:

InElementType

InElementType:

NoTruncation

NoTruncation:

None

None:

UseFullyQualifiedType

UseFullyQualifiedType:

UseTypeOfFunction

UseTypeOfFunction:

WriteArrayAsGenericType

WriteArrayAsGenericType:

WriteArrowStyleSignature

WriteArrowStyleSignature:

WriteOwnNameForAnyLike

WriteOwnNameForAnyLike:

WriteTypeArgumentsOfSignature

WriteTypeArgumentsOfSignature:

TypePredicateKind

TypePredicateKind:

Identifier

Identifier:

This

This:

ClassificationTypeNames

ClassificationTypeNames:

className

className: string

comment

comment: string

docCommentTagName

docCommentTagName: string

enumName

enumName: string

identifier

identifier: string

interfaceName

interfaceName: string

jsxAttribute

jsxAttribute: string

jsxAttributeStringLiteralValue

jsxAttributeStringLiteralValue: string

jsxCloseTagName

jsxCloseTagName: string

jsxOpenTagName

jsxOpenTagName: string

jsxSelfClosingTagName

jsxSelfClosingTagName: string

jsxText

jsxText: string

keyword

keyword: string

moduleName

moduleName: string

numericLiteral

numericLiteral: string

operator

operator: string

parameterName

parameterName: string

punctuation

punctuation: string

stringLiteral

stringLiteral: string

text

text: string

typeAliasName

typeAliasName: string

typeParameterName

typeParameterName: string

whiteSpace

whiteSpace: string

OperationCanceledException

OperationCanceledException:

TextChange

TextChange:

newText

newText: string

span

span: TextSpan

AccessorDeclaration

AccessorDeclaration:

_accessorDeclarationBrand

_accessorDeclarationBrand: any

_classElementBrand

_classElementBrand: any

_declarationBrand

_declarationBrand: any

_functionLikeDeclarationBrand

_functionLikeDeclarationBrand: any

_objectLiteralBrandBrand

_objectLiteralBrandBrand: any

asteriskToken

asteriskToken: Node

body

decorators

decorators: NodeArray<Decorator>

end

end: number

flags

flags: NodeFlags

kind

modifiers

modifiers: ModifiersArray

name

parameters

parent

parent: Node

pos

pos: number

questionToken

questionToken: Node

type

type: TypeNode

typeParameters

AmdDependency

AmdDependency:

name

name: string

path

path: string

ArrayBindingPattern

ArrayBindingPattern:

decorators

decorators: NodeArray<Decorator>

elements

end

end: number

flags

flags: NodeFlags

kind

modifiers

modifiers: ModifiersArray

parent

parent: Node

pos

pos: number

ArrayLiteralExpression

ArrayLiteralExpression:

_expressionBrand

_expressionBrand: any

_incrementExpressionBrand

_incrementExpressionBrand: any

_leftHandSideExpressionBrand

_leftHandSideExpressionBrand: any

_memberExpressionBrand

_memberExpressionBrand: any

_primaryExpressionBrand

_primaryExpressionBrand: any

_unaryExpressionBrand

_unaryExpressionBrand: any

contextualType

contextualType: Type

decorators

decorators: NodeArray<Decorator>

elements

end

end: number

flags

flags: NodeFlags

kind

modifiers

modifiers: ModifiersArray

parent

parent: Node

pos

pos: number

ArrayTypeNode

ArrayTypeNode:

_typeNodeBrand

_typeNodeBrand: any

decorators

decorators: NodeArray<Decorator>

elementType

elementType: TypeNode

end

end: number

flags

flags: NodeFlags

kind

modifiers

modifiers: ModifiersArray

parent

parent: Node

pos

pos: number

ArrowFunction

ArrowFunction:

_declarationBrand

_declarationBrand: any

_expressionBrand

_expressionBrand: any

_functionLikeDeclarationBrand

_functionLikeDeclarationBrand: any

asteriskToken

asteriskToken: Node

body

contextualType

contextualType: Type

decorators

decorators: NodeArray<Decorator>

end

end: number

equalsGreaterThanToken

equalsGreaterThanToken: Node

flags

flags: NodeFlags

kind

modifiers

modifiers: ModifiersArray

name

parameters

parent

parent: Node

pos

pos: number

questionToken

questionToken: Node

type

type: TypeNode

typeParameters

AsExpression

AsExpression:

_expressionBrand

_expressionBrand: any

contextualType

contextualType: Type

decorators

decorators: NodeArray<Decorator>

end

end: number

expression

expression: Expression

flags

flags: NodeFlags

kind

modifiers

modifiers: ModifiersArray

parent

parent: Node

pos

pos: number

type

type: TypeNode

AwaitExpression

AwaitExpression:

_expressionBrand

_expressionBrand: any

_unaryExpressionBrand

_unaryExpressionBrand: any

contextualType

contextualType: Type

decorators

decorators: NodeArray<Decorator>

end

end: number

expression

expression: UnaryExpression

flags

flags: NodeFlags

kind

modifiers

modifiers: ModifiersArray

parent

parent: Node

pos

pos: number

BinaryExpression

BinaryExpression:

_declarationBrand

_declarationBrand: any

_expressionBrand

_expressionBrand: any

contextualType

contextualType: Type

decorators

decorators: NodeArray<Decorator>

end

end: number

flags

flags: NodeFlags

kind

left

modifiers

modifiers: ModifiersArray

name

operatorToken

operatorToken: Node

parent

parent: Node

pos

pos: number

right

right: Expression

BindingElement

BindingElement:

_declarationBrand

_declarationBrand: any

decorators

decorators: NodeArray<Decorator>

dotDotDotToken

dotDotDotToken: Node

end

end: number

flags

flags: NodeFlags

initializer

initializer: Expression

kind

modifiers

modifiers: ModifiersArray

name

parent

parent: Node

pos

pos: number

propertyName

propertyName: PropertyName

BindingPattern

BindingPattern:

decorators

decorators: NodeArray<Decorator>

elements

end

end: number

flags

flags: NodeFlags

kind

modifiers

modifiers: ModifiersArray

parent

parent: Node

pos

pos: number

getChildAt

  • Parameters

    Returns Node

getChildCount

  • Parameters

    Returns number

getChildren

  • Parameters

    Returns Node[]

getEnd

  • getEnd(): number
  • Returns number

getFirstToken

getFullStart

  • getFullStart(): number
  • Returns number

getFullText

  • Parameters

    Returns string

getFullWidth

  • getFullWidth(): number
  • Returns number

getLastToken

  • Parameters

    Returns Node

getLeadingTriviaWidth

  • getLeadingTriviaWidth(sourceFile?: SourceFile): number

getSourceFile

getStart

  • Parameters

    Returns number

getText

  • Parameters

    Returns string

getWidth

  • Parameters

    Returns number

Block

Block:

_statementBrand

_statementBrand: any

decorators

decorators: NodeArray<Decorator>

end

end: number

flags

flags: NodeFlags

kind

modifiers

modifiers: ModifiersArray

parent

parent: Node

pos

pos: number

statements

statements: NodeArray<Statement>

BreakStatement

BreakStatement:

_statementBrand

_statementBrand: any

decorators

decorators: NodeArray<Decorator>

end

end: number

flags

flags: NodeFlags

kind

label

label: Identifier

modifiers

modifiers: ModifiersArray

parent

parent: Node

pos

pos: number

CallExpression

CallExpression:

_declarationBrand

_declarationBrand: any

_expressionBrand

_expressionBrand: any

_incrementExpressionBrand

_incrementExpressionBrand: any

_leftHandSideExpressionBrand

_leftHandSideExpressionBrand: any

_unaryExpressionBrand

_unaryExpressionBrand: any

arguments

arguments: NodeArray<Expression>

contextualType

contextualType: Type

decorators

decorators: NodeArray<Decorator>

end

end: number

expression

flags

flags: NodeFlags

kind

modifiers

modifiers: ModifiersArray

name

parent

parent: Node

pos

pos: number

typeArguments

typeArguments: NodeArray<TypeNode>

CallSignatureDeclaration

CallSignatureDeclaration:

_declarationBrand

_declarationBrand: any

_typeElementBrand

_typeElementBrand: any

decorators

decorators: NodeArray<Decorator>

end

end: number

flags

flags: NodeFlags

kind

modifiers

modifiers: ModifiersArray

name

parameters

parent

parent: Node

pos

pos: number

questionToken

questionToken: Node

type

type: TypeNode

typeParameters

CancellationToken

CancellationToken:

isCancellationRequested

  • isCancellationRequested(): boolean
  • Returns boolean

throwIfCancellationRequested

  • throwIfCancellationRequested(): void
  • throws

    OperationCanceledException if isCancellationRequested is true

    Returns void

CaseBlock

CaseBlock:

clauses

decorators

decorators: NodeArray<Decorator>

end

end: number

flags

flags: NodeFlags

kind

modifiers

modifiers: ModifiersArray

parent

parent: Node

pos

pos: number

getChildAt

  • Parameters

    Returns Node

getChildCount

  • Parameters

    Returns number

getChildren

  • Parameters

    Returns Node[]

getEnd

  • getEnd(): number
  • Returns number

getFirstToken

getFullStart

  • getFullStart(): number
  • Returns number

getFullText

  • Parameters

    Returns string

getFullWidth

  • getFullWidth(): number
  • Returns number

getLastToken

  • Parameters

    Returns Node

getLeadingTriviaWidth

  • getLeadingTriviaWidth(sourceFile?: SourceFile): number

getSourceFile

getStart

  • Parameters

    Returns number

getText

  • Parameters

    Returns string

getWidth

  • Parameters

    Returns number

CaseClause

CaseClause:

decorators

decorators: NodeArray<Decorator>

end

end: number

expression

expression: Expression

flags

flags: NodeFlags

kind

modifiers

modifiers: ModifiersArray

parent

parent: Node

pos

pos: number

statements

statements: NodeArray<Statement>

getChildAt

  • Parameters

    Returns Node

getChildCount

  • Parameters

    Returns number

getChildren

  • Parameters

    Returns Node[]

getEnd

  • getEnd(): number
  • Returns number

getFirstToken

getFullStart

  • getFullStart(): number
  • Returns number

getFullText

  • Parameters

    Returns string

getFullWidth

  • getFullWidth(): number
  • Returns number

getLastToken

  • Parameters

    Returns Node

getLeadingTriviaWidth

  • getLeadingTriviaWidth(sourceFile?: SourceFile): number

getSourceFile

getStart

  • Parameters

    Returns number

getText

  • Parameters

    Returns string

getWidth

  • Parameters

    Returns number

CatchClause

CatchClause:

block

block: Block

decorators

decorators: NodeArray<Decorator>

end

end: number

flags

flags: NodeFlags

kind

modifiers

modifiers: ModifiersArray

parent

parent: Node

pos

pos: number

variableDeclaration

variableDeclaration: VariableDeclaration

getChildAt

  • Parameters

    Returns Node

getChildCount

  • Parameters

    Returns number

getChildren

  • Parameters

    Returns Node[]

getEnd

  • getEnd(): number
  • Returns number

getFirstToken

getFullStart

  • getFullStart(): number
  • Returns number

getFullText

  • Parameters

    Returns string

getFullWidth

  • getFullWidth(): number
  • Returns number

getLastToken

  • Parameters

    Returns Node

getLeadingTriviaWidth

  • getLeadingTriviaWidth(sourceFile?: SourceFile): number

getSourceFile

getStart

  • Parameters

    Returns number

getText

  • Parameters

    Returns string

getWidth

  • Parameters

    Returns number

ClassDeclaration

ClassDeclaration:

_declarationBrand

_declarationBrand: any

_statementBrand

_statementBrand: any

decorators

decorators: NodeArray<Decorator>

end

end: number

flags

flags: NodeFlags

heritageClauses

heritageClauses: NodeArray<HeritageClause>

kind

members

modifiers

modifiers: ModifiersArray

name

parent

parent: Node

pos

pos: number

typeParameters

ClassElement

ClassElement:

_classElementBrand

_classElementBrand: any

_declarationBrand

_declarationBrand: any

decorators

decorators: NodeArray<Decorator>

end

end: number

flags

flags: NodeFlags

kind

modifiers

modifiers: ModifiersArray

name

parent

parent: Node

pos

pos: number

ClassExpression

ClassExpression:

_declarationBrand

_declarationBrand: any

_expressionBrand

_expressionBrand: any

_incrementExpressionBrand

_incrementExpressionBrand: any

_leftHandSideExpressionBrand

_leftHandSideExpressionBrand: any

_memberExpressionBrand

_memberExpressionBrand: any

_primaryExpressionBrand

_primaryExpressionBrand: any

_unaryExpressionBrand

_unaryExpressionBrand: any

contextualType

contextualType: Type

decorators

decorators: NodeArray<Decorator>

end

end: number

flags

flags: NodeFlags

heritageClauses

heritageClauses: NodeArray<HeritageClause>

kind

members

modifiers

modifiers: ModifiersArray

name

parent

parent: Node

pos

pos: number

typeParameters

ClassLikeDeclaration

ClassLikeDeclaration:

_declarationBrand

_declarationBrand: any

decorators

decorators: NodeArray<Decorator>

end

end: number

flags

flags: NodeFlags

heritageClauses

heritageClauses: NodeArray<HeritageClause>

kind

members

modifiers

modifiers: ModifiersArray

name

parent

parent: Node

pos

pos: number

typeParameters

ClassificationInfo

ClassificationInfo:

classification

classification: TokenClass

length

length: number

ClassificationResult

ClassificationResult:

entries

finalLexState

finalLexState: EndOfLineState

Classifications

Classifications:

endOfLineState

endOfLineState: EndOfLineState

spans

spans: number[]

ClassifiedSpan

ClassifiedSpan:

classificationType

classificationType: string

textSpan

textSpan: TextSpan

Classifier

Classifier:

getClassificationsForLine

  • Gives lexical classifications of tokens on a line without any syntactic context. For instance, a token consisting of the text 'string' can be either an identifier named 'string' or the keyword 'string', however, because this classifier is not aware, it relies on certain heuristics to give acceptable results. For classifications where speed trumps accuracy, this function is preferable; however, for true accuracy, the syntactic classifier is ideal. In fact, in certain editing scenarios, combining the lexical, syntactic, and semantic classifiers may issue the best user experience.

    deprecated

    Use getLexicalClassifications instead.

    Parameters

    • text: string

      The text of a line to classify.

    • lexState: EndOfLineState

      The state of the lexical classifier at the end of the previous line.

    • syntacticClassifierAbsent: boolean

      Whether the client is not using a syntactic classifier. If there is no syntactic classifier (syntacticClassifierAbsent=true), certain heuristics may be used in its place; however, if there is a syntactic classifier (syntacticClassifierAbsent=false), certain classifications which may be incorrectly categorized will be given back as Identifiers in order to allow the syntactic classifier to subsume the classification.

    Returns ClassificationResult

getEncodedLexicalClassifications

  • Parameters

    • text: string
    • endOfLineState: EndOfLineState
    • syntacticClassifierAbsent: boolean

    Returns Classifications

CommentRange

CommentRange:

end

end: number

hasTrailingNewLine

hasTrailingNewLine: boolean

kind

pos

pos: number

CompilerHost

CompilerHost:

writeFile

directoryExists

  • directoryExists(directoryName: string): boolean

fileExists

  • fileExists(fileName: string): boolean
  • Parameters

    • fileName: string

    Returns boolean

getCancellationToken

  • Returns CancellationToken

getCanonicalFileName

  • getCanonicalFileName(fileName: string): string
  • Parameters

    • fileName: string

    Returns string

getCurrentDirectory

  • getCurrentDirectory(): string
  • Returns string

getDefaultLibFileName

  • Parameters

    Returns string

getNewLine

  • getNewLine(): string
  • Returns string

getSourceFile

  • Parameters

    • fileName: string
    • languageVersion: ScriptTarget
    • Optional onError: function
        • (message: string): void
        • Parameters

          • message: string

          Returns void

    Returns SourceFile

readFile

  • readFile(fileName: string): string
  • Parameters

    • fileName: string

    Returns string

resolveModuleNames

  • resolveModuleNames(moduleNames: string[], containingFile: string): ResolvedModule[]
  • Parameters

    • moduleNames: string[]
    • containingFile: string

    Returns ResolvedModule[]

useCaseSensitiveFileNames

  • useCaseSensitiveFileNames(): boolean
  • Returns boolean

CompilerOptions

CompilerOptions:

allowJs

allowJs: boolean

allowNonTsExtensions

allowNonTsExtensions: boolean

allowSyntheticDefaultImports

allowSyntheticDefaultImports: boolean

allowUnreachableCode

allowUnreachableCode: boolean

allowUnusedLabels

allowUnusedLabels: boolean

charset

charset: string

declaration

declaration: boolean

diagnostics

diagnostics: boolean

emitBOM

emitBOM: boolean

emitDecoratorMetadata

emitDecoratorMetadata: boolean

experimentalDecorators

experimentalDecorators: boolean

forceConsistentCasingInFileNames

forceConsistentCasingInFileNames: boolean

help

help: boolean

init

init: boolean

inlineSourceMap

inlineSourceMap: boolean

inlineSources

inlineSources: boolean

isolatedModules

isolatedModules: boolean

jsx

jsx: JsxEmit

listFiles

listFiles: boolean

locale

locale: string

mapRoot

mapRoot: string

module

module: ModuleKind

moduleResolution

moduleResolution: ModuleResolutionKind

newLine

newLine: NewLineKind

noEmit

noEmit: boolean

noEmitHelpers

noEmitHelpers: boolean

noEmitOnError

noEmitOnError: boolean

noErrorTruncation

noErrorTruncation: boolean

noFallthroughCasesInSwitch

noFallthroughCasesInSwitch: boolean

noImplicitAny

noImplicitAny: boolean

noImplicitReturns

noImplicitReturns: boolean

noImplicitUseStrict

noImplicitUseStrict: boolean

noLib

noLib: boolean

noResolve

noResolve: boolean

out

out: string

outDir

outDir: string

outFile

outFile: string

preserveConstEnums

preserveConstEnums: boolean

project

project: string

reactNamespace

reactNamespace: string

removeComments

removeComments: boolean

rootDir

rootDir: string

sourceMap

sourceMap: boolean

sourceRoot

sourceRoot: string

suppressExcessPropertyErrors

suppressExcessPropertyErrors: boolean

suppressImplicitAnyIndexErrors

suppressImplicitAnyIndexErrors: boolean

target

target: ScriptTarget

version

version: boolean

watch

watch: boolean

CompletionEntry

CompletionEntry:

kind

kind: string

kindModifiers

kindModifiers: string

name

name: string

sortText

sortText: string

CompletionEntryDetails

CompletionEntryDetails:

displayParts

displayParts: SymbolDisplayPart[]

documentation

documentation: SymbolDisplayPart[]

kind

kind: string

kindModifiers

kindModifiers: string

name

name: string

CompletionInfo

CompletionInfo:

entries

entries: CompletionEntry[]

isMemberCompletion

isMemberCompletion: boolean

isNewIdentifierLocation

isNewIdentifierLocation: boolean

ComputedPropertyName

ComputedPropertyName:

decorators

decorators: NodeArray<Decorator>

end

end: number

expression

expression: Expression

flags

flags: NodeFlags

kind

modifiers

modifiers: ModifiersArray

parent

parent: Node

pos

pos: number

getChildAt

  • Parameters

    Returns Node

getChildCount

  • Parameters

    Returns number

getChildren

  • Parameters

    Returns Node[]

getEnd

  • getEnd(): number
  • Returns number

getFirstToken

getFullStart

  • getFullStart(): number
  • Returns number

getFullText

  • Parameters

    Returns string

getFullWidth

  • getFullWidth(): number
  • Returns number

getLastToken

  • Parameters

    Returns Node

getLeadingTriviaWidth

  • getLeadingTriviaWidth(sourceFile?: SourceFile): number

getSourceFile

getStart

  • Parameters

    Returns number

getText

  • Parameters

    Returns string

getWidth

  • Parameters

    Returns number

ConditionalExpression

ConditionalExpression:

_expressionBrand

_expressionBrand: any

colonToken

colonToken: Node

condition

condition: Expression

contextualType

contextualType: Type

decorators

decorators: NodeArray<Decorator>

end

end: number

flags

flags: NodeFlags

kind

modifiers

modifiers: ModifiersArray

parent

parent: Node

pos

pos: number

questionToken

questionToken: Node

whenFalse

whenFalse: Expression

whenTrue

whenTrue: Expression

ConstructSignatureDeclaration

ConstructSignatureDeclaration:

_declarationBrand

_declarationBrand: any

_typeElementBrand

_typeElementBrand: any

decorators

decorators: NodeArray<Decorator>

end

end: number

flags

flags: NodeFlags

kind

modifiers

modifiers: ModifiersArray

name

parameters

parent

parent: Node

pos

pos: number

questionToken

questionToken: Node

type

type: TypeNode

typeParameters

ConstructorDeclaration

ConstructorDeclaration:

_classElementBrand

_classElementBrand: any

_declarationBrand

_declarationBrand: any

_functionLikeDeclarationBrand

_functionLikeDeclarationBrand: any

asteriskToken

asteriskToken: Node

body

decorators

decorators: NodeArray<Decorator>

end

end: number

flags

flags: NodeFlags

kind

modifiers

modifiers: ModifiersArray

name

parameters

parent

parent: Node

pos

pos: number

questionToken

questionToken: Node

type

type: TypeNode

typeParameters

ConstructorTypeNode

ConstructorTypeNode:

_declarationBrand

_declarationBrand: any

_functionOrConstructorTypeNodeBrand

_functionOrConstructorTypeNodeBrand: any

_typeNodeBrand

_typeNodeBrand: any

decorators

decorators: NodeArray<Decorator>

end

end: number

flags

flags: NodeFlags

kind

modifiers

modifiers: ModifiersArray

name

parameters

parent

parent: Node

pos

pos: number

type

type: TypeNode

typeParameters

ContinueStatement

ContinueStatement:

_statementBrand

_statementBrand: any

decorators

decorators: NodeArray<Decorator>

end

end: number

flags

flags: NodeFlags

kind

label

label: Identifier

modifiers

modifiers: ModifiersArray

parent

parent: Node

pos

pos: number

DebuggerStatement

DebuggerStatement:

_statementBrand

_statementBrand: any

decorators

decorators: NodeArray<Decorator>

end

end: number

flags

flags: NodeFlags

kind

modifiers

modifiers: ModifiersArray

parent

parent: Node

pos

pos: number

Declaration

Declaration:

_declarationBrand

_declarationBrand: any

decorators

decorators: NodeArray<Decorator>

end

end: number

flags

flags: NodeFlags

kind

modifiers

modifiers: ModifiersArray

name

parent

parent: Node

pos

pos: number

getChildAt

  • Parameters

    Returns Node

getChildCount

  • Parameters

    Returns number

getChildren

  • Parameters

    Returns Node[]

getEnd

  • getEnd(): number
  • Returns number

getFirstToken

getFullStart

  • getFullStart(): number
  • Returns number

getFullText

  • Parameters

    Returns string

getFullWidth

  • getFullWidth(): number
  • Returns number

getLastToken

  • Parameters

    Returns Node

getLeadingTriviaWidth

  • getLeadingTriviaWidth(sourceFile?: SourceFile): number

getSourceFile

getStart

  • Parameters

    Returns number

getText

  • Parameters

    Returns string

getWidth

  • Parameters

    Returns number

DeclarationStatement

DeclarationStatement:

_declarationBrand

_declarationBrand: any

_statementBrand

_statementBrand: any

decorators

decorators: NodeArray<Decorator>

end

end: number

flags

flags: NodeFlags

kind

modifiers

modifiers: ModifiersArray

name

parent

parent: Node

pos

pos: number

Decorator

Decorator:

decorators

decorators: NodeArray<Decorator>

end

end: number

expression

flags

flags: NodeFlags

kind

modifiers

modifiers: ModifiersArray

parent

parent: Node

pos

pos: number

getChildAt

  • Parameters

    Returns Node

getChildCount

  • Parameters

    Returns number

getChildren

  • Parameters

    Returns Node[]

getEnd

  • getEnd(): number
  • Returns number

getFirstToken

getFullStart

  • getFullStart(): number
  • Returns number

getFullText

  • Parameters

    Returns string

getFullWidth

  • getFullWidth(): number
  • Returns number

getLastToken

  • Parameters

    Returns Node

getLeadingTriviaWidth

  • getLeadingTriviaWidth(sourceFile?: SourceFile): number

getSourceFile

getStart

  • Parameters

    Returns number

getText

  • Parameters

    Returns string

getWidth

  • Parameters

    Returns number

DefaultClause

DefaultClause:

decorators

decorators: NodeArray<Decorator>

end

end: number

flags

flags: NodeFlags

kind

modifiers

modifiers: ModifiersArray

parent

parent: Node

pos

pos: number

statements

statements: NodeArray<Statement>

getChildAt

  • Parameters

    Returns Node

getChildCount

  • Parameters

    Returns number

getChildren

  • Parameters

    Returns Node[]

getEnd

  • getEnd(): number
  • Returns number

getFirstToken

getFullStart

  • getFullStart(): number
  • Returns number

getFullText

  • Parameters

    Returns string

getFullWidth

  • getFullWidth(): number
  • Returns number

getLastToken

  • Parameters

    Returns Node

getLeadingTriviaWidth

  • getLeadingTriviaWidth(sourceFile?: SourceFile): number

getSourceFile

getStart

  • Parameters

    Returns number

getText

  • Parameters

    Returns string

getWidth

  • Parameters

    Returns number

DefinitionInfo

DefinitionInfo:

containerKind

containerKind: string

containerName

containerName: string

fileName

fileName: string

kind

kind: string

name

name: string

textSpan

textSpan: TextSpan

DeleteExpression

DeleteExpression:

_expressionBrand

_expressionBrand: any

_unaryExpressionBrand

_unaryExpressionBrand: any

contextualType

contextualType: Type

decorators

decorators: NodeArray<Decorator>

end

end: number

expression

expression: UnaryExpression

flags

flags: NodeFlags

kind

modifiers

modifiers: ModifiersArray

parent

parent: Node

pos

pos: number

Diagnostic

Diagnostic:

category

code

code: number

file

length

length: number

messageText

messageText: string | DiagnosticMessageChain

start

start: number

DiagnosticMessage

DiagnosticMessage:

category

code

code: number

key

key: string

message

message: string

DiagnosticMessageChain

DiagnosticMessageChain:

A linked list of formatted diagnostic messages to be used as part of a multiline message. It is built from the bottom up, leaving the head to be the "main" diagnostic. While it seems that DiagnosticMessageChain is structurally similar to DiagnosticMessage, the difference is that messages are all preformatted in DMC.

category

code

code: number

messageText

messageText: string

next

DirectoryWatcher

DirectoryWatcher:

directoryPath

directoryPath: Path

referenceCount

referenceCount: number

close

  • close(): void
  • Returns void

DisplayPartsSymbolWriter

DisplayPartsSymbolWriter:

clear

  • clear(): void
  • Returns void

decreaseIndent

  • decreaseIndent(): void

displayParts

  • Returns SymbolDisplayPart[]

increaseIndent

  • increaseIndent(): void

reportInaccessibleThisError

  • reportInaccessibleThisError(): void

trackSymbol

writeKeyword

  • writeKeyword(text: string): void
  • Parameters

    • text: string

    Returns void

writeLine

  • writeLine(): void
  • Returns void

writeOperator

  • writeOperator(text: string): void
  • Parameters

    • text: string

    Returns void

writeParameter

  • writeParameter(text: string): void
  • Parameters

    • text: string

    Returns void

writePunctuation

  • writePunctuation(text: string): void
  • Parameters

    • text: string

    Returns void

writeSpace

  • writeSpace(text: string): void
  • Parameters

    • text: string

    Returns void

writeStringLiteral

  • writeStringLiteral(text: string): void

writeSymbol

  • writeSymbol(text: string, symbol: Symbol): void
  • Parameters

    Returns void

DoStatement

DoStatement:

_statementBrand

_statementBrand: any

decorators

decorators: NodeArray<Decorator>

end

end: number

expression

expression: Expression

flags

flags: NodeFlags

kind

modifiers

modifiers: ModifiersArray

parent

parent: Node

pos

pos: number

statement

statement: Statement

DocumentHighlights

DocumentHighlights:

fileName

fileName: string

highlightSpans

highlightSpans: HighlightSpan[]

DocumentRegistry

DocumentRegistry:

The document registry represents a store of SourceFile objects that can be shared between multiple LanguageService instances. A LanguageService instance holds on the SourceFile (AST) of files in the context. SourceFile objects account for most of the memory usage by the language service. Sharing the same DocumentRegistry instance between different instances of LanguageService allow for more efficient memory utilization since all projects will share at least the library file (lib.d.ts).

A more advanced use of the document registry is to serialize sourceFile objects to disk and re-hydrate them when needed.

To create a default DocumentRegistry, use createDocumentRegistry to create one, and pass it to all subsequent createLanguageService calls.

acquireDocument

  • Request a stored SourceFile with a given fileName and compilationSettings. The first call to acquire will call createLanguageServiceSourceFile to generate the SourceFile if was not found in the registry.

    parm

    scriptSnapshot Text of the file. Only used if the file was not found in the registry and a new one was created.

    parm

    version Current version of the file. Only used if the file was not found in the registry and a new one was created.

    Parameters

    • fileName: string

      The name of the file requested

    • compilationSettings: CompilerOptions

      Some compilation settings like target affects the shape of a the resulting SourceFile. This allows the DocumentRegistry to store multiple copies of the same file for different compilation settings.

    • scriptSnapshot: IScriptSnapshot
    • version: string

    Returns SourceFile

releaseDocument

  • releaseDocument(fileName: string, compilationSettings: CompilerOptions): void
  • Informs the DocumentRegistry that a file is not needed any longer.

    Note: It is not allowed to call release on a SourceFile that was not acquired from this registry originally.

    Parameters

    • fileName: string

      The name of the file to be released

    • compilationSettings: CompilerOptions

      The compilation settings used to acquire the file

    Returns void

reportStats

  • reportStats(): string
  • Returns string

updateDocument

  • Request an updated version of an already existing SourceFile with a given fileName and compilationSettings. The update will in-turn call updateLanguageServiceSourceFile to get an updated SourceFile.

    Parameters

    • fileName: string

      The name of the file requested

    • compilationSettings: CompilerOptions

      Some compilation settings like target affects the shape of a the resulting SourceFile. This allows the DocumentRegistry to store multiple copies of the same file for different compilation settings.

    • scriptSnapshot: IScriptSnapshot

      Text of the file.

    • version: string

      Current version of the file.

    Returns SourceFile

EditorOptions

EditorOptions:

ConvertTabsToSpaces

ConvertTabsToSpaces: boolean

IndentSize

IndentSize: number

IndentStyle

IndentStyle: IndentStyle

NewLineCharacter

NewLineCharacter: string

TabSize

TabSize: number

ElementAccessExpression

ElementAccessExpression:

_expressionBrand

_expressionBrand: any

_incrementExpressionBrand

_incrementExpressionBrand: any

_leftHandSideExpressionBrand

_leftHandSideExpressionBrand: any

_memberExpressionBrand

_memberExpressionBrand: any

_unaryExpressionBrand

_unaryExpressionBrand: any

argumentExpression

argumentExpression: Expression

contextualType

contextualType: Type

decorators

decorators: NodeArray<Decorator>

end

end: number

expression

flags

flags: NodeFlags

kind

modifiers

modifiers: ModifiersArray

parent

parent: Node

pos

pos: number

EmitOutput

EmitOutput:

emitSkipped

emitSkipped: boolean

outputFiles

outputFiles: OutputFile[]

EmitResult

EmitResult:

diagnostics

diagnostics: Diagnostic[]

emitSkipped

emitSkipped: boolean

EmptyStatement

EmptyStatement:

_statementBrand

_statementBrand: any

decorators

decorators: NodeArray<Decorator>

end

end: number

flags

flags: NodeFlags

kind

modifiers

modifiers: ModifiersArray

parent

parent: Node

pos

pos: number

EnumDeclaration

EnumDeclaration:

_declarationBrand

_declarationBrand: any

_statementBrand

_statementBrand: any

decorators

decorators: NodeArray<Decorator>

end

end: number

flags

flags: NodeFlags

kind

members

modifiers

modifiers: ModifiersArray

name

parent

parent: Node

pos

pos: number

EnumMember

EnumMember:

_declarationBrand

_declarationBrand: any

decorators

decorators: NodeArray<Decorator>

end

end: number

flags

flags: NodeFlags

initializer

initializer: Expression

kind

modifiers

modifiers: ModifiersArray

name

parent

parent: Node

pos

pos: number

ErrorCallback

  • Parameters

    Returns void

ExportAssignment

ExportAssignment:

_declarationBrand

_declarationBrand: any

_statementBrand

_statementBrand: any

decorators

decorators: NodeArray<Decorator>

end

end: number

expression

expression: Expression

flags

flags: NodeFlags

isExportEquals

isExportEquals: boolean

kind

modifiers

modifiers: ModifiersArray

name

parent

parent: Node

pos

pos: number

ExportDeclaration

ExportDeclaration:

_declarationBrand

_declarationBrand: any

_statementBrand

_statementBrand: any

decorators

decorators: NodeArray<Decorator>

end

end: number

exportClause

exportClause: NamedExports

flags

flags: NodeFlags

kind

modifiers

modifiers: ModifiersArray

moduleSpecifier

moduleSpecifier: Expression

name

parent

parent: Node

pos

pos: number

ExportSpecifier

ExportSpecifier:

_declarationBrand

_declarationBrand: any

decorators

decorators: NodeArray<Decorator>

end

end: number

flags

flags: NodeFlags

kind

modifiers

modifiers: ModifiersArray

name

parent

parent: Node

pos

pos: number

propertyName

propertyName: Identifier

Expression

Expression:

_expressionBrand

_expressionBrand: any

contextualType

contextualType: Type

decorators

decorators: NodeArray<Decorator>

end

end: number

flags

flags: NodeFlags

kind

modifiers

modifiers: ModifiersArray

parent

parent: Node

pos

pos: number

getChildAt

  • Parameters

    Returns Node

getChildCount

  • Parameters

    Returns number

getChildren

  • Parameters

    Returns Node[]

getEnd

  • getEnd(): number
  • Returns number

getFirstToken

getFullStart

  • getFullStart(): number
  • Returns number

getFullText

  • Parameters

    Returns string

getFullWidth

  • getFullWidth(): number
  • Returns number

getLastToken

  • Parameters

    Returns Node

getLeadingTriviaWidth

  • getLeadingTriviaWidth(sourceFile?: SourceFile): number

getSourceFile

getStart

  • Parameters

    Returns number

getText

  • Parameters

    Returns string

getWidth

  • Parameters

    Returns number

ExpressionStatement

ExpressionStatement:

_statementBrand

_statementBrand: any

decorators

decorators: NodeArray<Decorator>

end

end: number

expression

expression: Expression

flags

flags: NodeFlags

kind

modifiers

modifiers: ModifiersArray

parent

parent: Node

pos

pos: number

ExpressionWithTypeArguments

ExpressionWithTypeArguments:

_typeNodeBrand

_typeNodeBrand: any

decorators

decorators: NodeArray<Decorator>

end

end: number

expression

flags

flags: NodeFlags

kind

modifiers

modifiers: ModifiersArray

parent

parent: Node

pos

pos: number

typeArguments

typeArguments: NodeArray<TypeNode>

ExternalModuleReference

ExternalModuleReference:

decorators

decorators: NodeArray<Decorator>

end

end: number

expression

expression: Expression

flags

flags: NodeFlags

kind

modifiers

modifiers: ModifiersArray

parent

parent: Node

pos

pos: number

getChildAt

  • Parameters

    Returns Node

getChildCount

  • Parameters

    Returns number

getChildren

  • Parameters

    Returns Node[]

getEnd

  • getEnd(): number
  • Returns number

getFirstToken

getFullStart

  • getFullStart(): number
  • Returns number

getFullText

  • Parameters

    Returns string

getFullWidth

  • getFullWidth(): number
  • Returns number

getLastToken

  • Parameters

    Returns Node

getLeadingTriviaWidth

  • getLeadingTriviaWidth(sourceFile?: SourceFile): number

getSourceFile

getStart

  • Parameters

    Returns number

getText

  • Parameters

    Returns string

getWidth

  • Parameters

    Returns number

FileMap

FileMap:

clear

  • clear(): void
  • Returns void

contains

  • contains(fileName: Path): boolean
  • Parameters

    Returns boolean

forEachValue

  • forEachValue(f: function): void
  • Parameters

    • f: function
        • (key: Path, v: T): void
        • Parameters

          Returns void

    Returns void

get

  • get(fileName: Path): T
  • Parameters

    Returns T

remove

  • remove(fileName: Path): void
  • Parameters

    Returns void

set

  • set(fileName: Path, value: T): void
  • Parameters

    • fileName: Path
    • value: T

    Returns void

FileReference

FileReference:

end

end: number

fileName

fileName: string

pos

pos: number

FileWatcher

FileWatcher:

close

  • close(): void
  • Returns void

ForInStatement

ForInStatement:

_statementBrand

_statementBrand: any

decorators

decorators: NodeArray<Decorator>

end

end: number

expression

expression: Expression

flags

flags: NodeFlags

initializer

kind

modifiers

modifiers: ModifiersArray

parent

parent: Node

pos

pos: number

statement

statement: Statement

ForOfStatement

ForOfStatement:

_statementBrand

_statementBrand: any

decorators

decorators: NodeArray<Decorator>

end

end: number

expression

expression: Expression

flags

flags: NodeFlags

initializer

kind

modifiers

modifiers: ModifiersArray

parent

parent: Node

pos

pos: number

statement

statement: Statement

ForStatement

ForStatement:

_statementBrand

_statementBrand: any

condition

condition: Expression

decorators

decorators: NodeArray<Decorator>

end

end: number

flags

flags: NodeFlags

incrementor

incrementor: Expression

initializer

kind

modifiers

modifiers: ModifiersArray

parent

parent: Node

pos

pos: number

statement

statement: Statement

FormatCodeOptions

FormatCodeOptions:

ConvertTabsToSpaces

ConvertTabsToSpaces: boolean

IndentSize

IndentSize: number

IndentStyle

IndentStyle: IndentStyle

InsertSpaceAfterCommaDelimiter

InsertSpaceAfterCommaDelimiter: boolean

InsertSpaceAfterFunctionKeywordForAnonymousFunctions

InsertSpaceAfterFunctionKeywordForAnonymousFunctions: boolean

InsertSpaceAfterKeywordsInControlFlowStatements

InsertSpaceAfterKeywordsInControlFlowStatements: boolean

InsertSpaceAfterOpeningAndBeforeClosingNonemptyBrackets

InsertSpaceAfterOpeningAndBeforeClosingNonemptyBrackets: boolean

InsertSpaceAfterOpeningAndBeforeClosingNonemptyParenthesis

InsertSpaceAfterOpeningAndBeforeClosingNonemptyParenthesis: boolean

InsertSpaceAfterOpeningAndBeforeClosingTemplateStringBraces

InsertSpaceAfterOpeningAndBeforeClosingTemplateStringBraces: boolean

InsertSpaceAfterSemicolonInForStatements

InsertSpaceAfterSemicolonInForStatements: boolean

InsertSpaceBeforeAndAfterBinaryOperators

InsertSpaceBeforeAndAfterBinaryOperators: boolean

NewLineCharacter

NewLineCharacter: string

PlaceOpenBraceOnNewLineForControlBlocks

PlaceOpenBraceOnNewLineForControlBlocks: boolean

PlaceOpenBraceOnNewLineForFunctions

PlaceOpenBraceOnNewLineForFunctions: boolean

TabSize

TabSize: number

FunctionDeclaration

FunctionDeclaration:

_declarationBrand

_declarationBrand: any

_functionLikeDeclarationBrand

_functionLikeDeclarationBrand: any

_statementBrand

_statementBrand: any

asteriskToken

asteriskToken: Node

body

decorators

decorators: NodeArray<Decorator>

end

end: number

flags

flags: NodeFlags

kind

modifiers

modifiers: ModifiersArray

name

parameters

parent

parent: Node

pos

pos: number

questionToken

questionToken: Node

type

type: TypeNode

typeParameters

FunctionExpression

FunctionExpression:

_declarationBrand

_declarationBrand: any

_expressionBrand

_expressionBrand: any

_functionLikeDeclarationBrand

_functionLikeDeclarationBrand: any

_incrementExpressionBrand

_incrementExpressionBrand: any

_leftHandSideExpressionBrand

_leftHandSideExpressionBrand: any

_memberExpressionBrand

_memberExpressionBrand: any

_primaryExpressionBrand

_primaryExpressionBrand: any

_unaryExpressionBrand

_unaryExpressionBrand: any

asteriskToken

asteriskToken: Node

body

contextualType

contextualType: Type

decorators

decorators: NodeArray<Decorator>

end

end: number

flags

flags: NodeFlags

kind

modifiers

modifiers: ModifiersArray

name

parameters

parent

parent: Node

pos

pos: number

questionToken

questionToken: Node

type

type: TypeNode

typeParameters

FunctionLikeDeclaration

FunctionLikeDeclaration:

Several node kinds share function-like features such as a signature, a name, and a body. These nodes should extend FunctionLikeDeclaration. Examples:

  • FunctionDeclaration
  • MethodDeclaration
  • AccessorDeclaration

_declarationBrand

_declarationBrand: any

_functionLikeDeclarationBrand

_functionLikeDeclarationBrand: any

asteriskToken

asteriskToken: Node

body

decorators

decorators: NodeArray<Decorator>

end

end: number

flags

flags: NodeFlags

kind

modifiers

modifiers: ModifiersArray

name

parameters

parent

parent: Node

pos

pos: number

questionToken

questionToken: Node

type

type: TypeNode

typeParameters

FunctionOrConstructorTypeNode

FunctionOrConstructorTypeNode:

_declarationBrand

_declarationBrand: any

_functionOrConstructorTypeNodeBrand

_functionOrConstructorTypeNodeBrand: any

_typeNodeBrand

_typeNodeBrand: any

decorators

decorators: NodeArray<Decorator>

end

end: number

flags

flags: NodeFlags

kind

modifiers

modifiers: ModifiersArray

name

parameters

parent

parent: Node

pos

pos: number

type

type: TypeNode

typeParameters

FunctionTypeNode

FunctionTypeNode:

_declarationBrand

_declarationBrand: any

_functionOrConstructorTypeNodeBrand

_functionOrConstructorTypeNodeBrand: any

_typeNodeBrand

_typeNodeBrand: any

decorators

decorators: NodeArray<Decorator>

end

end: number

flags

flags: NodeFlags

kind

modifiers

modifiers: ModifiersArray

name

parameters

parent

parent: Node

pos

pos: number

type

type: TypeNode

typeParameters

GenericType

GenericType:

flags

flags: TypeFlags

localTypeParameters

localTypeParameters: TypeParameter[]

outerTypeParameters

outerTypeParameters: TypeParameter[]

pattern

symbol

symbol: Symbol

target

target: GenericType

thisType

thisType: TypeParameter

typeArguments

typeArguments: Type[]

typeParameters

typeParameters: TypeParameter[]

GetAccessorDeclaration

GetAccessorDeclaration:

_accessorDeclarationBrand

_accessorDeclarationBrand: any

_classElementBrand

_classElementBrand: any

_declarationBrand

_declarationBrand: any

_functionLikeDeclarationBrand

_functionLikeDeclarationBrand: any

_objectLiteralBrandBrand

_objectLiteralBrandBrand: any

asteriskToken

asteriskToken: Node

body

decorators

decorators: NodeArray<Decorator>

end

end: number

flags

flags: NodeFlags

kind

modifiers

modifiers: ModifiersArray

name

parameters

parent

parent: Node

pos

pos: number

questionToken

questionToken: Node

type

type: TypeNode

typeParameters

HeritageClause

HeritageClause:

decorators

decorators: NodeArray<Decorator>

end

end: number

flags

flags: NodeFlags

kind

modifiers

modifiers: ModifiersArray

parent

parent: Node

pos

pos: number

token

token: SyntaxKind

types

getChildAt

  • Parameters

    Returns Node

getChildCount

  • Parameters

    Returns number

getChildren

  • Parameters

    Returns Node[]

getEnd

  • getEnd(): number
  • Returns number

getFirstToken

getFullStart

  • getFullStart(): number
  • Returns number

getFullText

  • Parameters

    Returns string

getFullWidth

  • getFullWidth(): number
  • Returns number

getLastToken

  • Parameters

    Returns Node

getLeadingTriviaWidth

  • getLeadingTriviaWidth(sourceFile?: SourceFile): number

getSourceFile

getStart

  • Parameters

    Returns number

getText

  • Parameters

    Returns string

getWidth

  • Parameters

    Returns number

HighlightSpan

HighlightSpan:

fileName

fileName: string

kind

kind: string

textSpan

textSpan: TextSpan

HostCancellationToken

HostCancellationToken:

isCancellationRequested

  • isCancellationRequested(): boolean
  • Returns boolean

IScriptSnapshot

IScriptSnapshot:

Represents an immutable snapshot of a script at a specified time.Once acquired, the snapshot is observably immutable. i.e. the same calls with the same parameters will return the same values.

dispose

  • dispose(): void
  • Releases all resources held by this script snapshot

    Returns void

getChangeRange

  • Gets the TextChangeRange that describe how the text changed between this text and an older version. This information is used by the incremental parser to determine what sections of the script need to be re-parsed. 'undefined' can be returned if the change range cannot be determined. However, in that case, incremental parsing will not happen and the entire document will be re - parsed.

    Parameters

    Returns TextChangeRange

getLength

  • getLength(): number
  • Gets the length of this script snapshot.

    Returns number

getText

  • getText(start: number, end: number): string
  • Gets a portion of the script snapshot specified by [start, end).

    Parameters

    • start: number
    • end: number

    Returns string

Identifier

Identifier:

_expressionBrand

_expressionBrand: any

_incrementExpressionBrand

_incrementExpressionBrand: any

_leftHandSideExpressionBrand

_leftHandSideExpressionBrand: any

_memberExpressionBrand

_memberExpressionBrand: any

_primaryExpressionBrand

_primaryExpressionBrand: any

_unaryExpressionBrand

_unaryExpressionBrand: any

contextualType

contextualType: Type

decorators

decorators: NodeArray<Decorator>

end

end: number

flags

flags: NodeFlags

kind

modifiers

modifiers: ModifiersArray

originalKeywordKind

originalKeywordKind: SyntaxKind

parent

parent: Node

pos

pos: number

text

text: string

IdentifierTypePredicate

IdentifierTypePredicate:

kind

parameterIndex

parameterIndex: number

parameterName

parameterName: string

type

type: Type

IfStatement

IfStatement:

_statementBrand

_statementBrand: any

decorators

decorators: NodeArray<Decorator>

elseStatement

elseStatement: Statement

end

end: number

expression

expression: Expression

flags

flags: NodeFlags

kind

modifiers

modifiers: ModifiersArray

parent

parent: Node

pos

pos: number

thenStatement

thenStatement: Statement

ImportClause

ImportClause:

_declarationBrand

_declarationBrand: any

decorators

decorators: NodeArray<Decorator>

end

end: number

flags

flags: NodeFlags

kind

modifiers

modifiers: ModifiersArray

name

namedBindings

namedBindings: NamespaceImport | NamedImports

parent

parent: Node

pos

pos: number

ImportDeclaration

ImportDeclaration:

_statementBrand

_statementBrand: any

decorators

decorators: NodeArray<Decorator>

end

end: number

flags

flags: NodeFlags

importClause

importClause: ImportClause

kind

modifiers

modifiers: ModifiersArray

moduleSpecifier

moduleSpecifier: Expression

parent

parent: Node

pos

pos: number

ImportEqualsDeclaration

ImportEqualsDeclaration:

_declarationBrand

_declarationBrand: any

_statementBrand

_statementBrand: any

decorators

decorators: NodeArray<Decorator>

end

end: number

flags

flags: NodeFlags

kind

modifiers

modifiers: ModifiersArray

moduleReference

name

parent

parent: Node

pos

pos: number

ImportSpecifier

ImportSpecifier:

_declarationBrand

_declarationBrand: any

decorators

decorators: NodeArray<Decorator>

end

end: number

flags

flags: NodeFlags

kind

modifiers

modifiers: ModifiersArray

name

parent

parent: Node

pos

pos: number

propertyName

propertyName: Identifier

IncrementExpression

IncrementExpression:

_expressionBrand

_expressionBrand: any

_incrementExpressionBrand

_incrementExpressionBrand: any

_unaryExpressionBrand

_unaryExpressionBrand: any

contextualType

contextualType: Type

decorators

decorators: NodeArray<Decorator>

end

end: number

flags

flags: NodeFlags

kind

modifiers

modifiers: ModifiersArray

parent

parent: Node

pos

pos: number

IndexSignatureDeclaration

IndexSignatureDeclaration:

_classElementBrand

_classElementBrand: any

_declarationBrand

_declarationBrand: any

_indexSignatureDeclarationBrand

_indexSignatureDeclarationBrand: any

_typeElementBrand

_typeElementBrand: any

decorators

decorators: NodeArray<Decorator>

end

end: number

flags

flags: NodeFlags

kind

modifiers

modifiers: ModifiersArray

name

parameters

parent

parent: Node

pos

pos: number

questionToken

questionToken: Node

type

type: TypeNode

typeParameters

InterfaceDeclaration

InterfaceDeclaration:

_declarationBrand

_declarationBrand: any

_statementBrand

_statementBrand: any

decorators

decorators: NodeArray<Decorator>

end

end: number

flags

flags: NodeFlags

heritageClauses

heritageClauses: NodeArray<HeritageClause>

kind

members

modifiers

modifiers: ModifiersArray

name

parent

parent: Node

pos

pos: number

typeParameters

InterfaceType

InterfaceType:

flags

flags: TypeFlags

localTypeParameters

localTypeParameters: TypeParameter[]

outerTypeParameters

outerTypeParameters: TypeParameter[]

pattern

symbol

symbol: Symbol

thisType

thisType: TypeParameter

typeParameters

typeParameters: TypeParameter[]

InterfaceTypeWithDeclaredMembers

InterfaceTypeWithDeclaredMembers:

declaredCallSignatures

declaredCallSignatures: Signature[]

declaredConstructSignatures

declaredConstructSignatures: Signature[]

declaredNumberIndexType

declaredNumberIndexType: Type

declaredProperties

declaredProperties: Symbol[]

declaredStringIndexType

declaredStringIndexType: Type

flags

flags: TypeFlags

localTypeParameters

localTypeParameters: TypeParameter[]

outerTypeParameters

outerTypeParameters: TypeParameter[]

pattern

symbol

symbol: Symbol

thisType

thisType: TypeParameter

typeParameters

typeParameters: TypeParameter[]

IntersectionType

IntersectionType:

flags

flags: TypeFlags

pattern

symbol

symbol: Symbol

types

types: Type[]

IntersectionTypeNode

IntersectionTypeNode:

_typeNodeBrand

_typeNodeBrand: any

decorators

decorators: NodeArray<Decorator>

end

end: number

flags

flags: NodeFlags

kind

modifiers

modifiers: ModifiersArray

parent

parent: Node

pos

pos: number

types

IterationStatement

IterationStatement:

_statementBrand

_statementBrand: any

decorators

decorators: NodeArray<Decorator>

end

end: number

flags

flags: NodeFlags

kind

modifiers

modifiers: ModifiersArray

parent

parent: Node

pos

pos: number

statement

statement: Statement

JSDocAllType

JSDocAllType:

_JSDocAllTypeBrand

_JSDocAllTypeBrand: any

_jsDocTypeBrand

_jsDocTypeBrand: any

_typeNodeBrand

_typeNodeBrand: any

decorators

decorators: NodeArray<Decorator>

end

end: number

flags

flags: NodeFlags

kind

modifiers

modifiers: ModifiersArray

parent

parent: Node

pos

pos: number

JSDocArrayType

JSDocArrayType:

_jsDocTypeBrand

_jsDocTypeBrand: any

_typeNodeBrand

_typeNodeBrand: any

decorators

decorators: NodeArray<Decorator>

elementType

elementType: JSDocType

end

end: number

flags

flags: NodeFlags

kind

modifiers

modifiers: ModifiersArray

parent

parent: Node

pos

pos: number

JSDocComment

JSDocComment:

decorators

decorators: NodeArray<Decorator>

end

end: number

flags

flags: NodeFlags

kind

modifiers

modifiers: ModifiersArray

parent

parent: Node

pos

pos: number

tags

getChildAt

  • Parameters

    Returns Node

getChildCount

  • Parameters

    Returns number

getChildren

  • Parameters

    Returns Node[]

getEnd

  • getEnd(): number
  • Returns number

getFirstToken

getFullStart

  • getFullStart(): number
  • Returns number

getFullText

  • Parameters

    Returns string

getFullWidth

  • getFullWidth(): number
  • Returns number

getLastToken

  • Parameters

    Returns Node

getLeadingTriviaWidth

  • getLeadingTriviaWidth(sourceFile?: SourceFile): number

getSourceFile

getStart

  • Parameters

    Returns number

getText

  • Parameters

    Returns string

getWidth

  • Parameters

    Returns number

JSDocConstructorType

JSDocConstructorType:

_jsDocTypeBrand

_jsDocTypeBrand: any

_typeNodeBrand

_typeNodeBrand: any

decorators

decorators: NodeArray<Decorator>

end

end: number

flags

flags: NodeFlags

kind

modifiers

modifiers: ModifiersArray

parent

parent: Node

pos

pos: number

type

type: JSDocType

JSDocFunctionType

JSDocFunctionType:

_declarationBrand

_declarationBrand: any

_jsDocTypeBrand

_jsDocTypeBrand: any

_typeNodeBrand

_typeNodeBrand: any

decorators

decorators: NodeArray<Decorator>

end

end: number

flags

flags: NodeFlags

kind

modifiers

modifiers: ModifiersArray

name

parameters

parent

parent: Node

pos

pos: number

type

type: JSDocType

typeParameters

JSDocNonNullableType

JSDocNonNullableType:

_jsDocTypeBrand

_jsDocTypeBrand: any

_typeNodeBrand

_typeNodeBrand: any

decorators

decorators: NodeArray<Decorator>

end

end: number

flags

flags: NodeFlags

kind

modifiers

modifiers: ModifiersArray

parent

parent: Node

pos

pos: number

type

type: JSDocType

JSDocNullableType

JSDocNullableType:

_jsDocTypeBrand

_jsDocTypeBrand: any

_typeNodeBrand

_typeNodeBrand: any

decorators

decorators: NodeArray<Decorator>

end

end: number

flags

flags: NodeFlags

kind

modifiers

modifiers: ModifiersArray

parent

parent: Node

pos

pos: number

type

type: JSDocType

JSDocOptionalType

JSDocOptionalType:

_jsDocTypeBrand

_jsDocTypeBrand: any

_typeNodeBrand

_typeNodeBrand: any

decorators

decorators: NodeArray<Decorator>

end

end: number

flags

flags: NodeFlags

kind

modifiers

modifiers: ModifiersArray

parent

parent: Node

pos

pos: number

type

type: JSDocType

JSDocParameterTag

JSDocParameterTag:

atToken

atToken: Node

decorators

decorators: NodeArray<Decorator>

end

end: number

flags

flags: NodeFlags

isBracketed

isBracketed: boolean

kind

modifiers

modifiers: ModifiersArray

parent

parent: Node

pos

pos: number

postParameterName

postParameterName: Identifier

preParameterName

preParameterName: Identifier

tagName

tagName: Identifier

typeExpression

typeExpression: JSDocTypeExpression

JSDocRecordMember

JSDocRecordMember:

_declarationBrand

_declarationBrand: any

_typeElementBrand

_typeElementBrand: any

decorators

decorators: NodeArray<Decorator>

end

end: number

flags

flags: NodeFlags

initializer

initializer: Expression

kind

modifiers

modifiers: ModifiersArray

name

parent

parent: Node

pos

pos: number

questionToken

questionToken: Node

type

type: JSDocType

JSDocRecordType

JSDocRecordType:

_declarationBrand

_declarationBrand: any

_jsDocTypeBrand

_jsDocTypeBrand: any

_typeNodeBrand

_typeNodeBrand: any

decorators

decorators: NodeArray<Decorator>

end

end: number

flags

flags: NodeFlags

kind

members

modifiers

modifiers: ModifiersArray

name

parent

parent: Node

pos

pos: number

JSDocReturnTag

JSDocReturnTag:

atToken

atToken: Node

decorators

decorators: NodeArray<Decorator>

end

end: number

flags

flags: NodeFlags

kind

modifiers

modifiers: ModifiersArray

parent

parent: Node

pos

pos: number

tagName

tagName: Identifier

typeExpression

typeExpression: JSDocTypeExpression

JSDocTag

JSDocTag:

atToken

atToken: Node

decorators

decorators: NodeArray<Decorator>

end

end: number

flags

flags: NodeFlags

kind

modifiers

modifiers: ModifiersArray

parent

parent: Node

pos

pos: number

tagName

tagName: Identifier

getChildAt

  • Parameters

    Returns Node

getChildCount

  • Parameters

    Returns number

getChildren

  • Parameters

    Returns Node[]

getEnd

  • getEnd(): number
  • Returns number

getFirstToken

getFullStart

  • getFullStart(): number
  • Returns number

getFullText

  • Parameters

    Returns string

getFullWidth

  • getFullWidth(): number
  • Returns number

getLastToken

  • Parameters

    Returns Node

getLeadingTriviaWidth

  • getLeadingTriviaWidth(sourceFile?: SourceFile): number

getSourceFile

getStart

  • Parameters

    Returns number

getText

  • Parameters

    Returns string

getWidth

  • Parameters

    Returns number

JSDocTemplateTag

JSDocTemplateTag:

atToken

atToken: Node

decorators

decorators: NodeArray<Decorator>

end

end: number

flags

flags: NodeFlags

kind

modifiers

modifiers: ModifiersArray

parent

parent: Node

pos

pos: number

tagName

tagName: Identifier

typeParameters

JSDocThisType

JSDocThisType:

_jsDocTypeBrand

_jsDocTypeBrand: any

_typeNodeBrand

_typeNodeBrand: any

decorators

decorators: NodeArray<Decorator>

end

end: number

flags

flags: NodeFlags

kind

modifiers

modifiers: ModifiersArray

parent

parent: Node

pos

pos: number

type

type: JSDocType

JSDocTupleType

JSDocTupleType:

_jsDocTypeBrand

_jsDocTypeBrand: any

_typeNodeBrand

_typeNodeBrand: any

decorators

decorators: NodeArray<Decorator>

end

end: number

flags

flags: NodeFlags

kind

modifiers

modifiers: ModifiersArray

parent

parent: Node

pos

pos: number

types

JSDocType

JSDocType:

_jsDocTypeBrand

_jsDocTypeBrand: any

_typeNodeBrand

_typeNodeBrand: any

decorators

decorators: NodeArray<Decorator>

end

end: number

flags

flags: NodeFlags

kind

modifiers

modifiers: ModifiersArray

parent

parent: Node

pos

pos: number

JSDocTypeExpression

JSDocTypeExpression:

decorators

decorators: NodeArray<Decorator>

end

end: number

flags

flags: NodeFlags

kind

modifiers

modifiers: ModifiersArray

parent

parent: Node

pos

pos: number

type

type: JSDocType

getChildAt

  • Parameters

    Returns Node

getChildCount

  • Parameters

    Returns number

getChildren

  • Parameters

    Returns Node[]

getEnd

  • getEnd(): number
  • Returns number

getFirstToken

getFullStart

  • getFullStart(): number
  • Returns number

getFullText

  • Parameters

    Returns string

getFullWidth

  • getFullWidth(): number
  • Returns number

getLastToken

  • Parameters

    Returns Node

getLeadingTriviaWidth

  • getLeadingTriviaWidth(sourceFile?: SourceFile): number

getSourceFile

getStart

  • Parameters

    Returns number

getText

  • Parameters

    Returns string

getWidth

  • Parameters

    Returns number

JSDocTypeReference

JSDocTypeReference:

_jsDocTypeBrand

_jsDocTypeBrand: any

_typeNodeBrand

_typeNodeBrand: any

decorators

decorators: NodeArray<Decorator>

end

end: number

flags

flags: NodeFlags

kind

modifiers

modifiers: ModifiersArray

name

parent

parent: Node

pos

pos: number

typeArguments

typeArguments: NodeArray<JSDocType>

JSDocTypeTag

JSDocTypeTag:

atToken

atToken: Node

decorators

decorators: NodeArray<Decorator>

end

end: number

flags

flags: NodeFlags

kind

modifiers

modifiers: ModifiersArray

parent

parent: Node

pos

pos: number

tagName

tagName: Identifier

typeExpression

typeExpression: JSDocTypeExpression

JSDocUnionType

JSDocUnionType:

_jsDocTypeBrand

_jsDocTypeBrand: any

_typeNodeBrand

_typeNodeBrand: any

decorators

decorators: NodeArray<Decorator>

end

end: number

flags

flags: NodeFlags

kind

modifiers

modifiers: ModifiersArray

parent

parent: Node

pos

pos: number

types

JSDocUnknownType

JSDocUnknownType:

_JSDocUnknownTypeBrand

_JSDocUnknownTypeBrand: any

_jsDocTypeBrand

_jsDocTypeBrand: any

_typeNodeBrand

_typeNodeBrand: any

decorators

decorators: NodeArray<Decorator>

end

end: number

flags

flags: NodeFlags

kind

modifiers

modifiers: ModifiersArray

parent

parent: Node

pos

pos: number

JSDocVariadicType

JSDocVariadicType:

_jsDocTypeBrand

_jsDocTypeBrand: any

_typeNodeBrand

_typeNodeBrand: any

decorators

decorators: NodeArray<Decorator>

end

end: number

flags

flags: NodeFlags

kind

modifiers

modifiers: ModifiersArray

parent

parent: Node

pos

pos: number

type

type: JSDocType

JsxAttribute

JsxAttribute:

decorators

decorators: NodeArray<Decorator>

end

end: number

flags

flags: NodeFlags

initializer

initializer: Expression

kind

modifiers

modifiers: ModifiersArray

name

parent

parent: Node

pos

pos: number

getChildAt

  • Parameters

    Returns Node

getChildCount

  • Parameters

    Returns number

getChildren

  • Parameters

    Returns Node[]

getEnd

  • getEnd(): number
  • Returns number

getFirstToken

getFullStart

  • getFullStart(): number
  • Returns number

getFullText

  • Parameters

    Returns string

getFullWidth

  • getFullWidth(): number
  • Returns number

getLastToken

  • Parameters

    Returns Node

getLeadingTriviaWidth

  • getLeadingTriviaWidth(sourceFile?: SourceFile): number

getSourceFile

getStart

  • Parameters

    Returns number

getText

  • Parameters

    Returns string

getWidth

  • Parameters

    Returns number

JsxClosingElement

JsxClosingElement:

decorators

decorators: NodeArray<Decorator>

end

end: number

flags

flags: NodeFlags

kind

modifiers

modifiers: ModifiersArray

parent

parent: Node

pos

pos: number

tagName

tagName: EntityName

getChildAt

  • Parameters

    Returns Node

getChildCount

  • Parameters

    Returns number

getChildren

  • Parameters

    Returns Node[]

getEnd

  • getEnd(): number
  • Returns number

getFirstToken

getFullStart

  • getFullStart(): number
  • Returns number

getFullText

  • Parameters

    Returns string

getFullWidth

  • getFullWidth(): number
  • Returns number

getLastToken

  • Parameters

    Returns Node

getLeadingTriviaWidth

  • getLeadingTriviaWidth(sourceFile?: SourceFile): number

getSourceFile

getStart

  • Parameters

    Returns number

getText

  • Parameters

    Returns string

getWidth

  • Parameters

    Returns number

JsxElement

JsxElement:

_expressionBrand

_expressionBrand: any

_incrementExpressionBrand

_incrementExpressionBrand: any

_leftHandSideExpressionBrand

_leftHandSideExpressionBrand: any

_memberExpressionBrand

_memberExpressionBrand: any

_primaryExpressionBrand

_primaryExpressionBrand: any

_unaryExpressionBrand

_unaryExpressionBrand: any

children

children: NodeArray<JsxChild>

closingElement

closingElement: JsxClosingElement

contextualType

contextualType: Type

decorators

decorators: NodeArray<Decorator>

end

end: number

flags

flags: NodeFlags

kind

modifiers

modifiers: ModifiersArray

openingElement

openingElement: JsxOpeningElement

parent

parent: Node

pos

pos: number

JsxExpression

JsxExpression:

_expressionBrand

_expressionBrand: any

contextualType

contextualType: Type

decorators

decorators: NodeArray<Decorator>

end

end: number

expression

expression: Expression

flags

flags: NodeFlags

kind

modifiers

modifiers: ModifiersArray

parent

parent: Node

pos

pos: number

JsxOpeningElement

JsxOpeningElement:

_expressionBrand

_expressionBrand: any

_openingElementBrand

_openingElementBrand: any

attributes

contextualType

contextualType: Type

decorators

decorators: NodeArray<Decorator>

end

end: number

flags

flags: NodeFlags

kind

modifiers

modifiers: ModifiersArray

parent

parent: Node

pos

pos: number

tagName

tagName: EntityName

JsxSelfClosingElement

JsxSelfClosingElement:

_expressionBrand

_expressionBrand: any

_incrementExpressionBrand

_incrementExpressionBrand: any

_leftHandSideExpressionBrand

_leftHandSideExpressionBrand: any

_memberExpressionBrand

_memberExpressionBrand: any

_openingElementBrand

_openingElementBrand: any

_primaryExpressionBrand

_primaryExpressionBrand: any

_selfClosingElementBrand

_selfClosingElementBrand: any

_unaryExpressionBrand

_unaryExpressionBrand: any

attributes

contextualType

contextualType: Type

decorators

decorators: NodeArray<Decorator>

end

end: number

flags

flags: NodeFlags

kind

modifiers

modifiers: ModifiersArray

parent

parent: Node

pos

pos: number

tagName

tagName: EntityName

JsxSpreadAttribute

JsxSpreadAttribute:

decorators

decorators: NodeArray<Decorator>

end

end: number

expression

expression: Expression

flags

flags: NodeFlags

kind

modifiers

modifiers: ModifiersArray

parent

parent: Node

pos

pos: number

getChildAt

  • Parameters

    Returns Node

getChildCount

  • Parameters

    Returns number

getChildren

  • Parameters

    Returns Node[]

getEnd

  • getEnd(): number
  • Returns number

getFirstToken

getFullStart

  • getFullStart(): number
  • Returns number

getFullText

  • Parameters

    Returns string

getFullWidth

  • getFullWidth(): number
  • Returns number

getLastToken

  • Parameters

    Returns Node

getLeadingTriviaWidth

  • getLeadingTriviaWidth(sourceFile?: SourceFile): number

getSourceFile

getStart

  • Parameters

    Returns number

getText

  • Parameters

    Returns string

getWidth

  • Parameters

    Returns number

JsxText

JsxText:

_jsxTextExpressionBrand

_jsxTextExpressionBrand: any

decorators

decorators: NodeArray<Decorator>

end

end: number

flags

flags: NodeFlags

kind

modifiers

modifiers: ModifiersArray

parent

parent: Node

pos

pos: number

getChildAt

  • Parameters

    Returns Node

getChildCount

  • Parameters

    Returns number

getChildren

  • Parameters

    Returns Node[]

getEnd

  • getEnd(): number
  • Returns number

getFirstToken

getFullStart

  • getFullStart(): number
  • Returns number

getFullText

  • Parameters

    Returns string

getFullWidth

  • getFullWidth(): number
  • Returns number

getLastToken

  • Parameters

    Returns Node

getLeadingTriviaWidth

  • getLeadingTriviaWidth(sourceFile?: SourceFile): number

getSourceFile

getStart

  • Parameters

    Returns number

getText

  • Parameters

    Returns string

getWidth

  • Parameters

    Returns number

LabeledStatement

LabeledStatement:

_statementBrand

_statementBrand: any

decorators

decorators: NodeArray<Decorator>

end

end: number

flags

flags: NodeFlags

kind

label

label: Identifier

modifiers

modifiers: ModifiersArray

parent

parent: Node

pos

pos: number

statement

statement: Statement

LanguageService

LanguageService:

cleanupSemanticCache

  • cleanupSemanticCache(): void
  • Returns void

dispose

  • dispose(): void
  • Returns void

findReferences

  • Parameters

    • fileName: string
    • position: number

    Returns ReferencedSymbol[]

findRenameLocations

  • findRenameLocations(fileName: string, position: number, findInStrings: boolean, findInComments: boolean): RenameLocation[]
  • Parameters

    • fileName: string
    • position: number
    • findInStrings: boolean
    • findInComments: boolean

    Returns RenameLocation[]

getBraceMatchingAtPosition

  • getBraceMatchingAtPosition(fileName: string, position: number): TextSpan[]
  • Parameters

    • fileName: string
    • position: number

    Returns TextSpan[]

getBreakpointStatementAtPosition

  • getBreakpointStatementAtPosition(fileName: string, position: number): TextSpan
  • Parameters

    • fileName: string
    • position: number

    Returns TextSpan

getCompilerOptionsDiagnostics

  • Returns Diagnostic[]

getCompletionEntryDetails

  • Parameters

    • fileName: string
    • position: number
    • entryName: string

    Returns CompletionEntryDetails

getCompletionsAtPosition

  • getCompletionsAtPosition(fileName: string, position: number): CompletionInfo
  • Parameters

    • fileName: string
    • position: number

    Returns CompletionInfo

getDefinitionAtPosition

  • getDefinitionAtPosition(fileName: string, position: number): DefinitionInfo[]
  • Parameters

    • fileName: string
    • position: number

    Returns DefinitionInfo[]

getDocCommentTemplateAtPosition

  • getDocCommentTemplateAtPosition(fileName: string, position: number): TextInsertion
  • Parameters

    • fileName: string
    • position: number

    Returns TextInsertion

getDocumentHighlights

  • getDocumentHighlights(fileName: string, position: number, filesToSearch: string[]): DocumentHighlights[]
  • Parameters

    • fileName: string
    • position: number
    • filesToSearch: string[]

    Returns DocumentHighlights[]

getEmitOutput

  • Parameters

    • fileName: string

    Returns EmitOutput

getEncodedSemanticClassifications

  • Parameters

    Returns Classifications

getEncodedSyntacticClassifications

  • Parameters

    Returns Classifications

getFormattingEditsAfterKeystroke

  • Parameters

    Returns TextChange[]

getFormattingEditsForDocument

  • Parameters

    Returns TextChange[]

getFormattingEditsForRange

  • Parameters

    Returns TextChange[]

getIndentationAtPosition

  • getIndentationAtPosition(fileName: string, position: number, options: EditorOptions): number
  • Parameters

    Returns number

getNameOrDottedNameSpan

  • getNameOrDottedNameSpan(fileName: string, startPos: number, endPos: number): TextSpan
  • Parameters

    • fileName: string
    • startPos: number
    • endPos: number

    Returns TextSpan

getNavigateToItems

  • getNavigateToItems(searchValue: string, maxResultCount?: number): NavigateToItem[]
  • Parameters

    • searchValue: string
    • Optional maxResultCount: number

    Returns NavigateToItem[]

getNavigationBarItems

  • Parameters

    • fileName: string

    Returns NavigationBarItem[]

getOccurrencesAtPosition

  • getOccurrencesAtPosition(fileName: string, position: number): ReferenceEntry[]
  • deprecated

    Parameters

    • fileName: string
    • position: number

    Returns ReferenceEntry[]

getOutliningSpans

  • Parameters

    • fileName: string

    Returns OutliningSpan[]

getProgram

  • Returns Program

getQuickInfoAtPosition

  • getQuickInfoAtPosition(fileName: string, position: number): QuickInfo
  • Parameters

    • fileName: string
    • position: number

    Returns QuickInfo

getReferencesAtPosition

  • getReferencesAtPosition(fileName: string, position: number): ReferenceEntry[]
  • Parameters

    • fileName: string
    • position: number

    Returns ReferenceEntry[]

getRenameInfo

  • getRenameInfo(fileName: string, position: number): RenameInfo
  • Parameters

    • fileName: string
    • position: number

    Returns RenameInfo

getSemanticClassifications

  • deprecated

    Use getEncodedSemanticClassifications instead.

    Parameters

    Returns ClassifiedSpan[]

getSemanticDiagnostics

  • getSemanticDiagnostics(fileName: string): Diagnostic[]
  • Parameters

    • fileName: string

    Returns Diagnostic[]

getSignatureHelpItems

  • Parameters

    • fileName: string
    • position: number

    Returns SignatureHelpItems

getSourceFile

  • Parameters

    • fileName: string

    Returns SourceFile

getSyntacticClassifications

  • deprecated

    Use getEncodedSyntacticClassifications instead.

    Parameters

    Returns ClassifiedSpan[]

getSyntacticDiagnostics

  • getSyntacticDiagnostics(fileName: string): Diagnostic[]
  • Parameters

    • fileName: string

    Returns Diagnostic[]

getTodoComments

getTypeDefinitionAtPosition

  • getTypeDefinitionAtPosition(fileName: string, position: number): DefinitionInfo[]
  • Parameters

    • fileName: string
    • position: number

    Returns DefinitionInfo[]

LanguageServiceHost

LanguageServiceHost:

directoryExists

  • directoryExists(directoryName: string): boolean
  • Parameters

    • directoryName: string

    Returns boolean

error

  • error(s: string): void
  • Parameters

    • s: string

    Returns void

getCancellationToken

getCompilationSettings

  • Returns CompilerOptions

getCurrentDirectory

  • getCurrentDirectory(): string
  • Returns string

getDefaultLibFileName

  • Parameters

    Returns string

getLocalizedDiagnosticMessages

  • getLocalizedDiagnosticMessages(): any
  • Returns any

getNewLine

  • getNewLine(): string
  • Returns string

getProjectVersion

  • getProjectVersion(): string
  • Returns string

getScriptFileNames

  • getScriptFileNames(): string[]
  • Returns string[]

getScriptSnapshot

  • Parameters

    • fileName: string

    Returns IScriptSnapshot

getScriptVersion

  • getScriptVersion(fileName: string): string
  • Parameters

    • fileName: string

    Returns string

log

  • log(s: string): void
  • Parameters

    • s: string

    Returns void

resolveModuleNames

  • resolveModuleNames(moduleNames: string[], containingFile: string): ResolvedModule[]
  • Parameters

    • moduleNames: string[]
    • containingFile: string

    Returns ResolvedModule[]

trace

  • trace(s: string): void
  • Parameters

    • s: string

    Returns void

useCaseSensitiveFileNames

  • useCaseSensitiveFileNames(): boolean
  • Returns boolean

LeftHandSideExpression

LeftHandSideExpression:

_expressionBrand

_expressionBrand: any

_incrementExpressionBrand

_incrementExpressionBrand: any

_leftHandSideExpressionBrand

_leftHandSideExpressionBrand: any

_unaryExpressionBrand

_unaryExpressionBrand: any

contextualType

contextualType: Type

decorators

decorators: NodeArray<Decorator>

end

end: number

flags

flags: NodeFlags

kind

modifiers

modifiers: ModifiersArray

parent

parent: Node

pos

pos: number

LineAndCharacter

LineAndCharacter:

character

character: number

line

line: number

LiteralExpression

LiteralExpression:

_expressionBrand

_expressionBrand: any

_incrementExpressionBrand

_incrementExpressionBrand: any

_leftHandSideExpressionBrand

_leftHandSideExpressionBrand: any

_literalExpressionBrand

_literalExpressionBrand: any

_memberExpressionBrand

_memberExpressionBrand: any

_primaryExpressionBrand

_primaryExpressionBrand: any

_unaryExpressionBrand

_unaryExpressionBrand: any

contextualType

contextualType: Type

decorators

decorators: NodeArray<Decorator>

end

end: number

flags

flags: NodeFlags

hasExtendedUnicodeEscape

hasExtendedUnicodeEscape: boolean

isUnterminated

isUnterminated: boolean

kind

modifiers

modifiers: ModifiersArray

parent

parent: Node

pos

pos: number

text

text: string

LiteralLikeNode

LiteralLikeNode:

decorators

decorators: NodeArray<Decorator>

end

end: number

flags

flags: NodeFlags

hasExtendedUnicodeEscape

hasExtendedUnicodeEscape: boolean

isUnterminated

isUnterminated: boolean

kind

modifiers

modifiers: ModifiersArray

parent

parent: Node

pos

pos: number

text

text: string

getChildAt

  • Parameters

    Returns Node

getChildCount

  • Parameters

    Returns number

getChildren

  • Parameters

    Returns Node[]

getEnd

  • getEnd(): number
  • Returns number

getFirstToken

getFullStart

  • getFullStart(): number
  • Returns number

getFullText

  • Parameters

    Returns string

getFullWidth

  • getFullWidth(): number
  • Returns number

getLastToken

  • Parameters

    Returns Node

getLeadingTriviaWidth

  • getLeadingTriviaWidth(sourceFile?: SourceFile): number

getSourceFile

getStart

  • Parameters

    Returns number

getText

  • Parameters

    Returns string

getWidth

  • Parameters

    Returns number

Map

Map:

MemberExpression

MemberExpression:

_expressionBrand

_expressionBrand: any

_incrementExpressionBrand

_incrementExpressionBrand: any

_leftHandSideExpressionBrand

_leftHandSideExpressionBrand: any

_memberExpressionBrand

_memberExpressionBrand: any

_unaryExpressionBrand

_unaryExpressionBrand: any

contextualType

contextualType: Type

decorators

decorators: NodeArray<Decorator>

end

end: number

flags

flags: NodeFlags

kind

modifiers

modifiers: ModifiersArray

parent

parent: Node

pos

pos: number

MethodDeclaration

MethodDeclaration:

_classElementBrand

_classElementBrand: any

_declarationBrand

_declarationBrand: any

_functionLikeDeclarationBrand

_functionLikeDeclarationBrand: any

_objectLiteralBrandBrand

_objectLiteralBrandBrand: any

asteriskToken

asteriskToken: Node

body

decorators

decorators: NodeArray<Decorator>

end

end: number

flags

flags: NodeFlags

kind

modifiers

modifiers: ModifiersArray

name

parameters

parent

parent: Node

pos

pos: number

questionToken

questionToken: Node

type

type: TypeNode

typeParameters

MethodSignature

MethodSignature:

_declarationBrand

_declarationBrand: any

_typeElementBrand

_typeElementBrand: any

decorators

decorators: NodeArray<Decorator>

end

end: number

flags

flags: NodeFlags

kind

modifiers

modifiers: ModifiersArray

name

parameters

parent

parent: Node

pos

pos: number

questionToken

questionToken: Node

type

type: TypeNode

typeParameters

MissingDeclaration

MissingDeclaration:

_classElementBrand

_classElementBrand: any

_declarationBrand

_declarationBrand: any

_objectLiteralBrandBrand

_objectLiteralBrandBrand: any

_statementBrand

_statementBrand: any

_typeElementBrand

_typeElementBrand: any

decorators

decorators: NodeArray<Decorator>

end

end: number

flags

flags: NodeFlags

kind

modifiers

modifiers: ModifiersArray

name

parent

parent: Node

pos

pos: number

questionToken

questionToken: Node

Modifier

Modifier:

decorators

decorators: NodeArray<Decorator>

end

end: number

flags

flags: NodeFlags

kind

modifiers

modifiers: ModifiersArray

parent

parent: Node

pos

pos: number

getChildAt

  • Parameters

    Returns Node

getChildCount

  • Parameters

    Returns number

getChildren

  • Parameters

    Returns Node[]

getEnd

  • getEnd(): number
  • Returns number

getFirstToken

getFullStart

  • getFullStart(): number
  • Returns number

getFullText

  • Parameters

    Returns string

getFullWidth

  • getFullWidth(): number
  • Returns number

getLastToken

  • Parameters

    Returns Node

getLeadingTriviaWidth

  • getLeadingTriviaWidth(sourceFile?: SourceFile): number

getSourceFile

getStart

  • Parameters

    Returns number

getText

  • Parameters

    Returns string

getWidth

  • Parameters

    Returns number

ModifiersArray

ModifiersArray:

end

end: number

flags

flags: number

hasTrailingComma

hasTrailingComma: boolean

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

pos

pos: number

concat

  • Combines two or more arrays.

    Type parameters

    Parameters

    • Rest ...items: U[]

      Additional items to add to the end of array1.

    Returns Modifier[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: Modifier[]

      Additional items to add to the end of array1.

    Returns Modifier[]

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

filter

  • filter(callbackfn: function, thisArg?: any): Modifier[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns Modifier[]

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

indexOf

  • indexOf(searchElement: Modifier, fromIndex?: number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: Modifier

      The value to locate in the array.

    • Optional fromIndex: number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

lastIndexOf

  • lastIndexOf(searchElement: Modifier, fromIndex?: number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: Modifier

      The value to locate in the array.

    • Optional fromIndex: number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • Removes the last element from an array and returns it.

    Returns Modifier

push

  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    • Rest ...items: Modifier[]

      New elements of the Array.

    Returns number

reduce

  • reduce(callbackfn: function, initialValue?: Modifier): Modifier
  • reduce<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

    • Optional initialValue: Modifier

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns Modifier

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: Modifier, currentIndex: number, array: Modifier[]): U
        • Parameters

          • previousValue: U
          • currentValue: Modifier
          • currentIndex: number
          • array: Modifier[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • reduceRight(callbackfn: function, initialValue?: Modifier): Modifier
  • reduceRight<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

    • Optional initialValue: Modifier

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns Modifier

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: Modifier, currentIndex: number, array: Modifier[]): U
        • Parameters

          • previousValue: U
          • currentValue: Modifier
          • currentIndex: number
          • array: Modifier[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • Reverses the elements in an Array.

    Returns Modifier[]

shift

  • Removes the first element from an array and returns it.

    Returns Modifier

slice

  • slice(start?: number, end?: number): Modifier[]
  • Returns a section of an array.

    Parameters

    • Optional start: number

      The beginning of the specified portion of the array.

    • Optional end: number

      The end of the specified portion of the array.

    Returns Modifier[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: function): Modifier[]
  • Sorts an array.

    Parameters

    • Optional compareFn: function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns Modifier[]

splice

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    Returns Modifier[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: Modifier[]

      Elements to insert into the array in place of the deleted elements.

    Returns Modifier[]

toLocaleString

  • toLocaleString(): string
  • Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: Modifier[]

      Elements to insert at the start of the Array.

    Returns number

ModuleBlock

ModuleBlock:

_statementBrand

_statementBrand: any

decorators

decorators: NodeArray<Decorator>

end

end: number

flags

flags: NodeFlags

kind

modifiers

modifiers: ModifiersArray

parent

parent: Node

pos

pos: number

statements

statements: NodeArray<Statement>

getChildAt

  • Parameters

    Returns Node

getChildCount

  • Parameters

    Returns number

getChildren

  • Parameters

    Returns Node[]

getEnd

  • getEnd(): number
  • Returns number

getFirstToken

getFullStart

  • getFullStart(): number
  • Returns number

getFullText

  • Parameters

    Returns string

getFullWidth

  • getFullWidth(): number
  • Returns number

getLastToken

  • Parameters

    Returns Node

getLeadingTriviaWidth

  • getLeadingTriviaWidth(sourceFile?: SourceFile): number

getSourceFile

getStart

  • Parameters

    Returns number

getText

  • Parameters

    Returns string

getWidth

  • Parameters

    Returns number

ModuleDeclaration

ModuleDeclaration:

_declarationBrand

_declarationBrand: any

_statementBrand

_statementBrand: any

body

decorators

decorators: NodeArray<Decorator>

end

end: number

flags

flags: NodeFlags

kind

modifiers

modifiers: ModifiersArray

name

parent

parent: Node

pos

pos: number

ModuleResolutionHost

ModuleResolutionHost:

directoryExists

  • directoryExists(directoryName: string): boolean
  • Parameters

    • directoryName: string

    Returns boolean

fileExists

  • fileExists(fileName: string): boolean
  • Parameters

    • fileName: string

    Returns boolean

readFile

  • readFile(fileName: string): string
  • Parameters

    • fileName: string

    Returns string

NamedExports

NamedExports:

decorators

decorators: NodeArray<Decorator>

elements

end

end: number

flags

flags: NodeFlags

kind

modifiers

modifiers: ModifiersArray

parent

parent: Node

pos

pos: number

getChildAt

  • Parameters

    Returns Node

getChildCount

  • Parameters

    Returns number

getChildren

  • Parameters

    Returns Node[]

getEnd

  • getEnd(): number
  • Returns number

getFirstToken

getFullStart

  • getFullStart(): number
  • Returns number

getFullText

  • Parameters

    Returns string

getFullWidth

  • getFullWidth(): number
  • Returns number

getLastToken

  • Parameters

    Returns Node

getLeadingTriviaWidth

  • getLeadingTriviaWidth(sourceFile?: SourceFile): number

getSourceFile

getStart

  • Parameters

    Returns number

getText

  • Parameters

    Returns string

getWidth

  • Parameters

    Returns number

NamedImports

NamedImports:

decorators

decorators: NodeArray<Decorator>

elements

end

end: number

flags

flags: NodeFlags

kind

modifiers

modifiers: ModifiersArray

parent

parent: Node

pos

pos: number

getChildAt

  • Parameters

    Returns Node

getChildCount

  • Parameters

    Returns number

getChildren

  • Parameters

    Returns Node[]

getEnd

  • getEnd(): number
  • Returns number

getFirstToken

getFullStart

  • getFullStart(): number
  • Returns number

getFullText

  • Parameters

    Returns string

getFullWidth

  • getFullWidth(): number
  • Returns number

getLastToken

  • Parameters

    Returns Node

getLeadingTriviaWidth

  • getLeadingTriviaWidth(sourceFile?: SourceFile): number

getSourceFile

getStart

  • Parameters

    Returns number

getText

  • Parameters

    Returns string

getWidth

  • Parameters

    Returns number

NamespaceImport

NamespaceImport:

_declarationBrand

_declarationBrand: any

decorators

decorators: NodeArray<Decorator>

end

end: number

flags

flags: NodeFlags

kind

modifiers

modifiers: ModifiersArray

name

parent

parent: Node

pos

pos: number

NavigateToItem

NavigateToItem:

containerKind

containerKind: string

containerName

containerName: string

fileName

fileName: string

isCaseSensitive

isCaseSensitive: boolean

kind

kind: string

kindModifiers

kindModifiers: string

matchKind

matchKind: string

name

name: string

textSpan

textSpan: TextSpan

NavigationBarItem

NavigationBarItem:

bolded

bolded: boolean

childItems

childItems: NavigationBarItem[]

grayed

grayed: boolean

indent

indent: number

kind

kind: string

kindModifiers

kindModifiers: string

spans

spans: TextSpan[]

text

text: string

NewExpression

NewExpression:

_declarationBrand

_declarationBrand: any

_expressionBrand

_expressionBrand: any

_incrementExpressionBrand

_incrementExpressionBrand: any

_leftHandSideExpressionBrand

_leftHandSideExpressionBrand: any

_memberExpressionBrand

_memberExpressionBrand: any

_primaryExpressionBrand

_primaryExpressionBrand: any

_unaryExpressionBrand

_unaryExpressionBrand: any

arguments

arguments: NodeArray<Expression>

contextualType

contextualType: Type

decorators

decorators: NodeArray<Decorator>

end

end: number

expression

flags

flags: NodeFlags

kind

modifiers

modifiers: ModifiersArray

name

parent

parent: Node

pos

pos: number

typeArguments

typeArguments: NodeArray<TypeNode>

Node

Node:

decorators

decorators: NodeArray<Decorator>

end

end: number

flags

flags: NodeFlags

kind

modifiers

modifiers: ModifiersArray

parent

parent: Node

pos

pos: number

getChildAt

  • Parameters

    Returns Node

getChildCount

  • Parameters

    Returns number

getChildren

  • Parameters

    Returns Node[]

getEnd

  • getEnd(): number
  • Returns number

getFirstToken

  • Parameters

    Returns Node

getFullStart

  • getFullStart(): number
  • Returns number

getFullText

  • Parameters

    Returns string

getFullWidth

  • getFullWidth(): number
  • Returns number

getLastToken

  • Parameters

    Returns Node

getLeadingTriviaWidth

  • getLeadingTriviaWidth(sourceFile?: SourceFile): number
  • Parameters

    Returns number

getSourceFile

  • Returns SourceFile

getStart

  • Parameters

    Returns number

getText

  • Parameters

    Returns string

getWidth

  • Parameters

    Returns number

NodeArray

NodeArray:

Array

Array: ArrayConstructor

end

end: number

hasTrailingComma

hasTrailingComma: boolean

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

pos

pos: number

concat

  • concat<U>(...items: U[]): T[]
  • concat(...items: T[]): T[]
  • Combines two or more arrays.

    Type parameters

    • U: T[]

    Parameters

    • Rest ...items: U[]

      Additional items to add to the end of array1.

    Returns T[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: T[]

      Additional items to add to the end of array1.

    Returns T[]

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

        • (value: T, index: number, array: T[]): boolean
        • Parameters

          • value: T
          • index: number
          • array: T[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

filter

  • filter(callbackfn: function, thisArg?: any): T[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: T, index: number, array: T[]): boolean
        • Parameters

          • value: T
          • index: number
          • array: T[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns T[]

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

        • (value: T, index: number, array: T[]): void
        • Parameters

          • value: T
          • index: number
          • array: T[]

          Returns void

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

indexOf

  • indexOf(searchElement: T, fromIndex?: number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: T

      The value to locate in the array.

    • Optional fromIndex: number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

lastIndexOf

  • lastIndexOf(searchElement: T, fromIndex?: number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: T

      The value to locate in the array.

    • Optional fromIndex: number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

        • (value: T, index: number, array: T[]): U
        • Parameters

          • value: T
          • index: number
          • array: T[]

          Returns U

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • pop(): T
  • Removes the last element from an array and returns it.

    Returns T

push

  • push(...items: T[]): number
  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    • Rest ...items: T[]

      New elements of the Array.

    Returns number

reduce

  • reduce(callbackfn: function, initialValue?: T): T
  • reduce<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: T, currentValue: T, currentIndex: number, array: T[]): T
        • Parameters

          • previousValue: T
          • currentValue: T
          • currentIndex: number
          • array: T[]

          Returns T

    • Optional initialValue: T

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns T

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: T, currentIndex: number, array: T[]): U
        • Parameters

          • previousValue: U
          • currentValue: T
          • currentIndex: number
          • array: T[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • reduceRight(callbackfn: function, initialValue?: T): T
  • reduceRight<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: T, currentValue: T, currentIndex: number, array: T[]): T
        • Parameters

          • previousValue: T
          • currentValue: T
          • currentIndex: number
          • array: T[]

          Returns T

    • Optional initialValue: T

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns T

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: T, currentIndex: number, array: T[]): U
        • Parameters

          • previousValue: U
          • currentValue: T
          • currentIndex: number
          • array: T[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • reverse(): T[]
  • Reverses the elements in an Array.

    Returns T[]

shift

  • shift(): T
  • Removes the first element from an array and returns it.

    Returns T

slice

  • slice(start?: number, end?: number): T[]
  • Returns a section of an array.

    Parameters

    • Optional start: number

      The beginning of the specified portion of the array.

    • Optional end: number

      The end of the specified portion of the array.

    Returns T[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

        • (value: T, index: number, array: T[]): boolean
        • Parameters

          • value: T
          • index: number
          • array: T[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: function): T[]
  • Sorts an array.

    Parameters

    • Optional compareFn: function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

        • (a: T, b: T): number
        • Parameters

          • a: T
          • b: T

          Returns number

    Returns T[]

splice

  • splice(start: number): T[]
  • splice(start: number, deleteCount: number, ...items: T[]): T[]
  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    Returns T[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: T[]

      Elements to insert into the array in place of the deleted elements.

    Returns T[]

toLocaleString

  • toLocaleString(): string
  • Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • unshift(...items: T[]): number
  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: T[]

      Elements to insert at the start of the Array.

    Returns number

ObjectBindingPattern

ObjectBindingPattern:

decorators

decorators: NodeArray<Decorator>

elements

end

end: number

flags

flags: NodeFlags

kind

modifiers

modifiers: ModifiersArray

parent

parent: Node

pos

pos: number

ObjectLiteralElement

ObjectLiteralElement:

_declarationBrand

_declarationBrand: any

_objectLiteralBrandBrand

_objectLiteralBrandBrand: any

decorators

decorators: NodeArray<Decorator>

end

end: number

flags

flags: NodeFlags

kind

modifiers

modifiers: ModifiersArray

name

parent

parent: Node

pos

pos: number

ObjectLiteralExpression

ObjectLiteralExpression:

_declarationBrand

_declarationBrand: any

_expressionBrand

_expressionBrand: any

_incrementExpressionBrand

_incrementExpressionBrand: any

_leftHandSideExpressionBrand

_leftHandSideExpressionBrand: any

_memberExpressionBrand

_memberExpressionBrand: any

_primaryExpressionBrand

_primaryExpressionBrand: any

_unaryExpressionBrand

_unaryExpressionBrand: any

contextualType

contextualType: Type

decorators

decorators: NodeArray<Decorator>

end

end: number

flags

flags: NodeFlags

kind

modifiers

modifiers: ModifiersArray

name

parent

parent: Node

pos

pos: number

properties

ObjectType

ObjectType:

flags

flags: TypeFlags

pattern

symbol

symbol: Symbol

getApparentProperties

  • getApparentProperties(): Symbol[]

getBaseTypes

getCallSignatures

getConstructSignatures

getFlags

  • Returns TypeFlags

getNumberIndexType

  • getNumberIndexType(): Type

getProperties

getProperty

  • getProperty(propertyName: string): Symbol
  • Parameters

    • propertyName: string

    Returns Symbol

getStringIndexType

  • getStringIndexType(): Type

getSymbol

  • Returns Symbol

OmittedExpression

OmittedExpression:

_expressionBrand

_expressionBrand: any

contextualType

contextualType: Type

decorators

decorators: NodeArray<Decorator>

end

end: number

flags

flags: NodeFlags

kind

modifiers

modifiers: ModifiersArray

parent

parent: Node

pos

pos: number

OutliningSpan

OutliningSpan:

autoCollapse

autoCollapse: boolean

Whether or not this region should be automatically collapsed when the 'Collapse to Definitions' command is invoked.

bannerText

bannerText: string

The text to display in the editor for the collapsed region.

hintSpan

hintSpan: TextSpan

The span of the document to display when the user hovers over the collapsed span.

textSpan

textSpan: TextSpan

The span of the document to actually collapse.

OutputFile

OutputFile:

name

name: string

text

text: string

writeByteOrderMark

writeByteOrderMark: boolean

ParameterDeclaration

ParameterDeclaration:

_declarationBrand

_declarationBrand: any

decorators

decorators: NodeArray<Decorator>

dotDotDotToken

dotDotDotToken: Node

end

end: number

flags

flags: NodeFlags

initializer

initializer: Expression

kind

modifiers

modifiers: ModifiersArray

name

parent

parent: Node

pos

pos: number

questionToken

questionToken: Node

type

type: TypeNode

ParenthesizedExpression

ParenthesizedExpression:

_expressionBrand

_expressionBrand: any

_incrementExpressionBrand

_incrementExpressionBrand: any

_leftHandSideExpressionBrand

_leftHandSideExpressionBrand: any

_memberExpressionBrand

_memberExpressionBrand: any

_primaryExpressionBrand

_primaryExpressionBrand: any

_unaryExpressionBrand

_unaryExpressionBrand: any

contextualType

contextualType: Type

decorators

decorators: NodeArray<Decorator>

end

end: number

expression

expression: Expression

flags

flags: NodeFlags

kind

modifiers

modifiers: ModifiersArray

parent

parent: Node

pos

pos: number

ParenthesizedTypeNode

ParenthesizedTypeNode:

_typeNodeBrand

_typeNodeBrand: any

decorators

decorators: NodeArray<Decorator>

end

end: number

flags

flags: NodeFlags

kind

modifiers

modifiers: ModifiersArray

parent

parent: Node

pos

pos: number

type

type: TypeNode

ParseConfigHost

ParseConfigHost:

readDirectory

  • readDirectory(rootDir: string, extension: string, exclude: string[]): string[]
  • Parameters

    • rootDir: string
    • extension: string
    • exclude: string[]

    Returns string[]

ParsedCommandLine

ParsedCommandLine:

errors

errors: Diagnostic[]

fileNames

fileNames: string[]

options

PostfixExpression

PostfixExpression:

_expressionBrand

_expressionBrand: any

_postfixExpressionBrand

_postfixExpressionBrand: any

_unaryExpressionBrand

_unaryExpressionBrand: any

contextualType

contextualType: Type

decorators

decorators: NodeArray<Decorator>

end

end: number

flags

flags: NodeFlags

kind

modifiers

modifiers: ModifiersArray

parent

parent: Node

pos

pos: number

PostfixUnaryExpression

PostfixUnaryExpression:

_expressionBrand

_expressionBrand: any

_incrementExpressionBrand

_incrementExpressionBrand: any

_unaryExpressionBrand

_unaryExpressionBrand: any

contextualType

contextualType: Type

decorators

decorators: NodeArray<Decorator>

end

end: number

flags

flags: NodeFlags

kind

modifiers

modifiers: ModifiersArray

operand

operator

operator: SyntaxKind

parent

parent: Node

pos

pos: number

PreProcessedFileInfo

PreProcessedFileInfo:

ambientExternalModules

ambientExternalModules: string[]

importedFiles

importedFiles: FileReference[]

isLibFile

isLibFile: boolean

referencedFiles

referencedFiles: FileReference[]

PrefixUnaryExpression

PrefixUnaryExpression:

_expressionBrand

_expressionBrand: any

_incrementExpressionBrand

_incrementExpressionBrand: any

_unaryExpressionBrand

_unaryExpressionBrand: any

contextualType

contextualType: Type

decorators

decorators: NodeArray<Decorator>

end

end: number

flags

flags: NodeFlags

kind

modifiers

modifiers: ModifiersArray

operand

operator

operator: SyntaxKind

parent

parent: Node

pos

pos: number

PrimaryExpression

PrimaryExpression:

_expressionBrand

_expressionBrand: any

_incrementExpressionBrand

_incrementExpressionBrand: any

_leftHandSideExpressionBrand

_leftHandSideExpressionBrand: any

_memberExpressionBrand

_memberExpressionBrand: any

_primaryExpressionBrand

_primaryExpressionBrand: any

_unaryExpressionBrand

_unaryExpressionBrand: any

contextualType

contextualType: Type

decorators

decorators: NodeArray<Decorator>

end

end: number

flags

flags: NodeFlags

kind

modifiers

modifiers: ModifiersArray

parent

parent: Node

pos

pos: number

Program

Program:

emit

  • Emits the JavaScript and declaration files. If targetSourceFile is not specified, then the JavaScript and declaration files will be produced for all the files in this program. If targetSourceFile is specified, then only the JavaScript and declaration for that specific file will be generated.

    If writeFile is not specified then the writeFile callback from the compiler host will be used for writing the JavaScript and declaration files. Otherwise, the writeFile parameter will be invoked when writing the JavaScript and declaration files.

    Parameters

    Returns EmitResult

getCompilerOptions

getCurrentDirectory

  • getCurrentDirectory(): string

getDeclarationDiagnostics

getGlobalDiagnostics

  • Parameters

    Returns Diagnostic[]

getOptionsDiagnostics

  • Parameters

    Returns Diagnostic[]

getRootFileNames

  • getRootFileNames(): string[]
  • Get a list of root file names that were passed to a 'createProgram'

    Returns string[]

getSemanticDiagnostics

getSourceFile

getSourceFiles

  • Get a list of files in the program

    Returns SourceFile[]

getSyntacticDiagnostics

getTypeChecker

  • Gets a type checker that can be used to semantically analyze source fils in the program.

    Returns TypeChecker

PropertyAccessExpression

PropertyAccessExpression:

_declarationBrand

_declarationBrand: any

_expressionBrand

_expressionBrand: any

_incrementExpressionBrand

_incrementExpressionBrand: any

_leftHandSideExpressionBrand

_leftHandSideExpressionBrand: any

_memberExpressionBrand

_memberExpressionBrand: any

_unaryExpressionBrand

_unaryExpressionBrand: any

contextualType

contextualType: Type

decorators

decorators: NodeArray<Decorator>

dotToken

dotToken: Node

end

end: number

expression

flags

flags: NodeFlags

kind

modifiers

modifiers: ModifiersArray

name

parent

parent: Node

pos

pos: number

PropertyAssignment

PropertyAssignment:

_declarationBrand

_declarationBrand: any

_objectLiteralBrandBrand

_objectLiteralBrandBrand: any

_propertyAssignmentBrand

_propertyAssignmentBrand: any

decorators

decorators: NodeArray<Decorator>

end

end: number

flags

flags: NodeFlags

initializer

initializer: Expression

kind

modifiers

modifiers: ModifiersArray

name

parent

parent: Node

pos

pos: number

questionToken

questionToken: Node

PropertyDeclaration

PropertyDeclaration:

_classElementBrand

_classElementBrand: any

_declarationBrand

_declarationBrand: any

decorators

decorators: NodeArray<Decorator>

end

end: number

flags

flags: NodeFlags

initializer

initializer: Expression

kind

modifiers

modifiers: ModifiersArray

name

parent

parent: Node

pos

pos: number

questionToken

questionToken: Node

type

type: TypeNode

PropertyLikeDeclaration

PropertyLikeDeclaration:

_declarationBrand

_declarationBrand: any

decorators

decorators: NodeArray<Decorator>

end

end: number

flags

flags: NodeFlags

kind

modifiers

modifiers: ModifiersArray

name

parent

parent: Node

pos

pos: number

PropertySignature

PropertySignature:

_declarationBrand

_declarationBrand: any

_typeElementBrand

_typeElementBrand: any

decorators

decorators: NodeArray<Decorator>

end

end: number

flags

flags: NodeFlags

initializer

initializer: Expression

kind

modifiers

modifiers: ModifiersArray

name

parent

parent: Node

pos

pos: number

questionToken

questionToken: Node

type

type: TypeNode

QualifiedName

QualifiedName:

decorators

decorators: NodeArray<Decorator>

end

end: number

flags

flags: NodeFlags

kind

left

modifiers

modifiers: ModifiersArray

parent

parent: Node

pos

pos: number

right

right: Identifier

getChildAt

  • Parameters

    Returns Node

getChildCount

  • Parameters

    Returns number

getChildren

  • Parameters

    Returns Node[]

getEnd

  • getEnd(): number
  • Returns number

getFirstToken

getFullStart

  • getFullStart(): number
  • Returns number

getFullText

  • Parameters

    Returns string

getFullWidth

  • getFullWidth(): number
  • Returns number

getLastToken

  • Parameters

    Returns Node

getLeadingTriviaWidth

  • getLeadingTriviaWidth(sourceFile?: SourceFile): number

getSourceFile

getStart

  • Parameters

    Returns number

getText

  • Parameters

    Returns string

getWidth

  • Parameters

    Returns number

QuickInfo

QuickInfo:

displayParts

displayParts: SymbolDisplayPart[]

documentation

documentation: SymbolDisplayPart[]

kind

kind: string

kindModifiers

kindModifiers: string

textSpan

textSpan: TextSpan

ReferenceEntry

ReferenceEntry:

fileName

fileName: string

isWriteAccess

isWriteAccess: boolean

textSpan

textSpan: TextSpan

ReferencedSymbol

ReferencedSymbol:

definition

definition: DefinitionInfo

references

references: ReferenceEntry[]

RenameInfo

RenameInfo:

canRename

canRename: boolean

displayName

displayName: string

fullDisplayName

fullDisplayName: string

kind

kind: string

kindModifiers

kindModifiers: string

localizedErrorMessage

localizedErrorMessage: string

triggerSpan

triggerSpan: TextSpan

RenameLocation

RenameLocation:

fileName

fileName: string

textSpan

textSpan: TextSpan

ResolvedModule

ResolvedModule:

isExternalLibraryImport

isExternalLibraryImport: boolean

resolvedFileName

resolvedFileName: string

ResolvedModuleWithFailedLookupLocations

ResolvedModuleWithFailedLookupLocations:

failedLookupLocations

failedLookupLocations: string[]

resolvedModule

resolvedModule: ResolvedModule

ReturnStatement

ReturnStatement:

_statementBrand

_statementBrand: any

decorators

decorators: NodeArray<Decorator>

end

end: number

expression

expression: Expression

flags

flags: NodeFlags

kind

modifiers

modifiers: ModifiersArray

parent

parent: Node

pos

pos: number

Scanner

Scanner:

getStartPos

  • getStartPos(): number
  • Returns number

getTextPos

  • getTextPos(): number
  • Returns number

getToken

  • Returns SyntaxKind

getTokenPos

  • getTokenPos(): number
  • Returns number

getTokenText

  • getTokenText(): string
  • Returns string

getTokenValue

  • getTokenValue(): string
  • Returns string

hasExtendedUnicodeEscape

  • hasExtendedUnicodeEscape(): boolean
  • Returns boolean

hasPrecedingLineBreak

  • hasPrecedingLineBreak(): boolean
  • Returns boolean

isIdentifier

  • isIdentifier(): boolean
  • Returns boolean

isReservedWord

  • isReservedWord(): boolean
  • Returns boolean

isUnterminated

  • isUnterminated(): boolean
  • Returns boolean

lookAhead

  • lookAhead<T>(callback: function): T
  • Type parameters

    • T

    Parameters

    • callback: function
        • (): T
        • Returns T

    Returns T

reScanGreaterToken

  • Returns SyntaxKind

reScanJsxToken

  • Returns SyntaxKind

reScanSlashToken

  • Returns SyntaxKind

reScanTemplateToken

  • Returns SyntaxKind

scan

  • Returns SyntaxKind

scanJSDocToken

  • Returns SyntaxKind

scanJsxIdentifier

  • Returns SyntaxKind

scanJsxToken

  • Returns SyntaxKind

scanRange

  • scanRange<T>(start: number, length: number, callback: function): T
  • Type parameters

    • T

    Parameters

    • start: number
    • length: number
    • callback: function
        • (): T
        • Returns T

    Returns T

setLanguageVariant

  • Parameters

    Returns void

setOnError

  • Parameters

    Returns void

setScriptTarget

  • Parameters

    Returns void

setText

  • setText(text: string, start?: number, length?: number): void
  • Parameters

    • text: string
    • Optional start: number
    • Optional length: number

    Returns void

setTextPos

  • setTextPos(textPos: number): void
  • Parameters

    • textPos: number

    Returns void

tryScan

  • tryScan<T>(callback: function): T
  • Type parameters

    • T

    Parameters

    • callback: function
        • (): T
        • Returns T

    Returns T

ScriptReferenceHost

ScriptReferenceHost:

getCompilerOptions

  • Returns CompilerOptions

getCurrentDirectory

  • getCurrentDirectory(): string
  • Returns string

getSourceFile

  • Parameters

    • fileName: string

    Returns SourceFile

SemicolonClassElement

SemicolonClassElement:

_classElementBrand

_classElementBrand: any

_declarationBrand

_declarationBrand: any

_semicolonClassElementBrand

_semicolonClassElementBrand: any

decorators

decorators: NodeArray<Decorator>

end

end: number

flags

flags: NodeFlags

kind

modifiers

modifiers: ModifiersArray

name

parent

parent: Node

pos

pos: number

SetAccessorDeclaration

SetAccessorDeclaration:

_accessorDeclarationBrand

_accessorDeclarationBrand: any

_classElementBrand

_classElementBrand: any

_declarationBrand

_declarationBrand: any

_functionLikeDeclarationBrand

_functionLikeDeclarationBrand: any

_objectLiteralBrandBrand

_objectLiteralBrandBrand: any

asteriskToken

asteriskToken: Node

body

decorators

decorators: NodeArray<Decorator>

end

end: number

flags

flags: NodeFlags

kind

modifiers

modifiers: ModifiersArray

name

parameters

parent

parent: Node

pos

pos: number

questionToken

questionToken: Node

type

type: TypeNode

typeParameters

ShorthandPropertyAssignment

ShorthandPropertyAssignment:

_declarationBrand

_declarationBrand: any

_objectLiteralBrandBrand

_objectLiteralBrandBrand: any

decorators

decorators: NodeArray<Decorator>

end

end: number

equalsToken

equalsToken: Node

flags

flags: NodeFlags

kind

modifiers

modifiers: ModifiersArray

name

objectAssignmentInitializer

objectAssignmentInitializer: Expression

parent

parent: Node

pos

pos: number

questionToken

questionToken: Node

Signature

Signature:

declaration

parameters

parameters: Symbol[]

typeParameters

typeParameters: TypeParameter[]

getDeclaration

getDocumentationComment

  • Returns SymbolDisplayPart[]

getParameters

  • Returns Symbol[]

getReturnType

  • getReturnType(): Type
  • Returns Type

getTypeParameters

  • getTypeParameters(): Type[]
  • Returns Type[]

SignatureDeclaration

SignatureDeclaration:

_declarationBrand

_declarationBrand: any

decorators

decorators: NodeArray<Decorator>

end

end: number

flags

flags: NodeFlags

kind

modifiers

modifiers: ModifiersArray

name

parameters

parent

parent: Node

pos

pos: number

type

type: TypeNode

typeParameters

SignatureHelpItem

SignatureHelpItem:

Represents a single signature to show in signature help. The id is used for subsequent calls into the language service to ask questions about the signature help item in the context of any documents that have been updated. i.e. after an edit has happened, while signature help is still active, the host can ask important questions like 'what parameter is the user currently contained within?'.

documentation

documentation: SymbolDisplayPart[]

isVariadic

isVariadic: boolean

parameters

prefixDisplayParts

prefixDisplayParts: SymbolDisplayPart[]

separatorDisplayParts

separatorDisplayParts: SymbolDisplayPart[]

suffixDisplayParts

suffixDisplayParts: SymbolDisplayPart[]

SignatureHelpItems

SignatureHelpItems:

Represents a set of signature help items, and the preferred item that should be selected.

applicableSpan

applicableSpan: TextSpan

argumentCount

argumentCount: number

argumentIndex

argumentIndex: number

items

selectedItemIndex

selectedItemIndex: number

SignatureHelpParameter

SignatureHelpParameter:

displayParts

displayParts: SymbolDisplayPart[]

documentation

documentation: SymbolDisplayPart[]

isOptional

isOptional: boolean

name

name: string

SourceFile

SourceFile:

_declarationBrand

_declarationBrand: any

amdDependencies

amdDependencies: AmdDependency[]

decorators

decorators: NodeArray<Decorator>

end

end: number

endOfFileToken

endOfFileToken: Node

fileName

fileName: string

flags

flags: NodeFlags

hasNoDefaultLib

hasNoDefaultLib: boolean

lib.d.ts should have a reference comment like

///

If any other file has this comment, it signals not to include lib.d.ts because this containing file is intended to act as a default library.

kind

languageVariant

languageVariant: LanguageVariant

languageVersion

languageVersion: ScriptTarget

modifiers

modifiers: ModifiersArray

moduleName

moduleName: string

name

parent

parent: Node

path

path: Path

pos

pos: number

referencedFiles

referencedFiles: FileReference[]

statements

statements: NodeArray<Statement>

text

text: string

getLineAndCharacterOfPosition

  • Parameters

    • pos: number

    Returns LineAndCharacter

getLineStarts

  • getLineStarts(): number[]
  • Returns number[]

getPositionOfLineAndCharacter

  • getPositionOfLineAndCharacter(line: number, character: number): number
  • Parameters

    • line: number
    • character: number

    Returns number

update

  • Parameters

    Returns SourceFile

SourceMapData

SourceMapData:

inputSourceFileNames

inputSourceFileNames: string[]

jsSourceMappingURL

jsSourceMappingURL: string

sourceMapDecodedMappings

sourceMapDecodedMappings: SourceMapSpan[]

sourceMapFile

sourceMapFile: string

sourceMapFilePath

sourceMapFilePath: string

sourceMapMappings

sourceMapMappings: string

sourceMapNames

sourceMapNames: string[]

sourceMapSourceRoot

sourceMapSourceRoot: string

sourceMapSources

sourceMapSources: string[]

sourceMapSourcesContent

sourceMapSourcesContent: string[]

SourceMapSpan

SourceMapSpan:

emittedColumn

emittedColumn: number

Column number in the .js file.

emittedLine

emittedLine: number

Line number in the .js file.

nameIndex

nameIndex: number

Optional name (index into names array) associated with this span.

sourceColumn

sourceColumn: number

Column number in the .ts file.

sourceIndex

sourceIndex: number

.ts file (index into sources array) associated with this span

sourceLine

sourceLine: number

Line number in the .ts file.

SpreadElementExpression

SpreadElementExpression:

_expressionBrand

_expressionBrand: any

contextualType

contextualType: Type

decorators

decorators: NodeArray<Decorator>

end

end: number

expression

expression: Expression

flags

flags: NodeFlags

kind

modifiers

modifiers: ModifiersArray

parent

parent: Node

pos

pos: number

Statement

Statement:

_statementBrand

_statementBrand: any

decorators

decorators: NodeArray<Decorator>

end

end: number

flags

flags: NodeFlags

kind

modifiers

modifiers: ModifiersArray

parent

parent: Node

pos

pos: number

getChildAt

  • Parameters

    Returns Node

getChildCount

  • Parameters

    Returns number

getChildren

  • Parameters

    Returns Node[]

getEnd

  • getEnd(): number
  • Returns number

getFirstToken

getFullStart

  • getFullStart(): number
  • Returns number

getFullText

  • Parameters

    Returns string

getFullWidth

  • getFullWidth(): number
  • Returns number

getLastToken

  • Parameters

    Returns Node

getLeadingTriviaWidth

  • getLeadingTriviaWidth(sourceFile?: SourceFile): number

getSourceFile

getStart

  • Parameters

    Returns number

getText

  • Parameters

    Returns string

getWidth

  • Parameters

    Returns number

StringLiteral

StringLiteral:

_expressionBrand

_expressionBrand: any

_incrementExpressionBrand

_incrementExpressionBrand: any

_leftHandSideExpressionBrand

_leftHandSideExpressionBrand: any

_literalExpressionBrand

_literalExpressionBrand: any

_memberExpressionBrand

_memberExpressionBrand: any

_primaryExpressionBrand

_primaryExpressionBrand: any

_stringLiteralBrand

_stringLiteralBrand: any

_unaryExpressionBrand

_unaryExpressionBrand: any

contextualType

contextualType: Type

decorators

decorators: NodeArray<Decorator>

end

end: number

flags

flags: NodeFlags

hasExtendedUnicodeEscape

hasExtendedUnicodeEscape: boolean

isUnterminated

isUnterminated: boolean

kind

modifiers

modifiers: ModifiersArray

parent

parent: Node

pos

pos: number

text

text: string

StringLiteralType

StringLiteralType:

flags

flags: TypeFlags

pattern

symbol

symbol: Symbol

text

text: string

getApparentProperties

  • getApparentProperties(): Symbol[]

getBaseTypes

getCallSignatures

getConstructSignatures

getFlags

  • Returns TypeFlags

getNumberIndexType

  • getNumberIndexType(): Type

getProperties

getProperty

  • getProperty(propertyName: string): Symbol
  • Parameters

    • propertyName: string

    Returns Symbol

getStringIndexType

  • getStringIndexType(): Type

getSymbol

  • Returns Symbol

StringLiteralTypeNode

StringLiteralTypeNode:

_stringLiteralTypeBrand

_stringLiteralTypeBrand: any

_typeNodeBrand

_typeNodeBrand: any

decorators

decorators: NodeArray<Decorator>

end

end: number

flags

flags: NodeFlags

hasExtendedUnicodeEscape

hasExtendedUnicodeEscape: boolean

isUnterminated

isUnterminated: boolean

kind

modifiers

modifiers: ModifiersArray

parent

parent: Node

pos

pos: number

text

text: string

SwitchStatement

SwitchStatement:

_statementBrand

_statementBrand: any

caseBlock

caseBlock: CaseBlock

decorators

decorators: NodeArray<Decorator>

end

end: number

expression

expression: Expression

flags

flags: NodeFlags

kind

modifiers

modifiers: ModifiersArray

parent

parent: Node

pos

pos: number

Symbol

Symbol:

declarations

declarations: Declaration[]

exports

exports: SymbolTable

flags

members

members: SymbolTable

name

name: string

valueDeclaration

valueDeclaration: Declaration

getDeclarations

  • Returns Declaration[]

getDocumentationComment

  • Returns SymbolDisplayPart[]

getFlags

  • Returns SymbolFlags

getName

  • getName(): string
  • Returns string

SymbolDisplayBuilder

SymbolDisplayBuilder:

buildDisplayForParametersAndDelimiters

  • Parameters

    Returns void

buildDisplayForTypeParametersAndDelimiters

buildParameterDisplay

  • Parameters

    Returns void

buildReturnTypeDisplay

buildSignatureDisplay

buildSymbolDisplay

buildTypeDisplay

  • Parameters

    Returns void

buildTypeParameterDisplay

buildTypeParameterDisplayFromSymbol

  • Parameters

    Returns void

buildTypePredicateDisplay

SymbolDisplayPart

SymbolDisplayPart:

kind

kind: string

text

text: string

SymbolTable

SymbolTable:

SymbolWriter

SymbolWriter:

clear

  • clear(): void
  • Returns void

decreaseIndent

  • decreaseIndent(): void
  • Returns void

increaseIndent

  • increaseIndent(): void
  • Returns void

reportInaccessibleThisError

  • reportInaccessibleThisError(): void
  • Returns void

trackSymbol

  • Parameters

    Returns void

writeKeyword

  • writeKeyword(text: string): void
  • Parameters

    • text: string

    Returns void

writeLine

  • writeLine(): void
  • Returns void

writeOperator

  • writeOperator(text: string): void
  • Parameters

    • text: string

    Returns void

writeParameter

  • writeParameter(text: string): void
  • Parameters

    • text: string

    Returns void

writePunctuation

  • writePunctuation(text: string): void
  • Parameters

    • text: string

    Returns void

writeSpace

  • writeSpace(text: string): void
  • Parameters

    • text: string

    Returns void

writeStringLiteral

  • writeStringLiteral(text: string): void
  • Parameters

    • text: string

    Returns void

writeSymbol

  • writeSymbol(text: string, symbol: Symbol): void
  • Parameters

    Returns void

System

System:

args

args: string[]

newLine

newLine: string

useCaseSensitiveFileNames

useCaseSensitiveFileNames: boolean

createDirectory

  • createDirectory(path: string): void
  • Parameters

    • path: string

    Returns void

directoryExists

  • directoryExists(path: string): boolean
  • Parameters

    • path: string

    Returns boolean

exit

  • exit(exitCode?: number): void
  • Parameters

    • Optional exitCode: number

    Returns void

fileExists

  • fileExists(path: string): boolean
  • Parameters

    • path: string

    Returns boolean

getCurrentDirectory

  • getCurrentDirectory(): string
  • Returns string

getExecutingFilePath

  • getExecutingFilePath(): string
  • Returns string

getMemoryUsage

  • getMemoryUsage(): number
  • Returns number

readDirectory

  • readDirectory(path: string, extension?: string, exclude?: string[]): string[]
  • Parameters

    • path: string
    • Optional extension: string
    • Optional exclude: string[]

    Returns string[]

readFile

  • readFile(path: string, encoding?: string): string
  • Parameters

    • path: string
    • Optional encoding: string

    Returns string

resolvePath

  • resolvePath(path: string): string
  • Parameters

    • path: string

    Returns string

watchDirectory

watchFile

write

  • write(s: string): void
  • Parameters

    • s: string

    Returns void

writeFile

  • writeFile(path: string, data: string, writeByteOrderMark?: boolean): void
  • Parameters

    • path: string
    • data: string
    • Optional writeByteOrderMark: boolean

    Returns void

TaggedTemplateExpression

TaggedTemplateExpression:

_expressionBrand

_expressionBrand: any

_incrementExpressionBrand

_incrementExpressionBrand: any

_leftHandSideExpressionBrand

_leftHandSideExpressionBrand: any

_memberExpressionBrand

_memberExpressionBrand: any

_unaryExpressionBrand

_unaryExpressionBrand: any

contextualType

contextualType: Type

decorators

decorators: NodeArray<Decorator>

end

end: number

flags

flags: NodeFlags

kind

modifiers

modifiers: ModifiersArray

parent

parent: Node

pos

pos: number

tag

template

TemplateExpression

TemplateExpression:

_expressionBrand

_expressionBrand: any

_incrementExpressionBrand

_incrementExpressionBrand: any

_leftHandSideExpressionBrand

_leftHandSideExpressionBrand: any

_memberExpressionBrand

_memberExpressionBrand: any

_primaryExpressionBrand

_primaryExpressionBrand: any

_unaryExpressionBrand

_unaryExpressionBrand: any

contextualType

contextualType: Type

decorators

decorators: NodeArray<Decorator>

end

end: number

flags

flags: NodeFlags

head

kind

modifiers

modifiers: ModifiersArray

parent

parent: Node

pos

pos: number

templateSpans

templateSpans: NodeArray<TemplateSpan>

TemplateLiteralFragment

TemplateLiteralFragment:

_templateLiteralFragmentBrand

_templateLiteralFragmentBrand: any

decorators

decorators: NodeArray<Decorator>

end

end: number

flags

flags: NodeFlags

hasExtendedUnicodeEscape

hasExtendedUnicodeEscape: boolean

isUnterminated

isUnterminated: boolean

kind

modifiers

modifiers: ModifiersArray

parent

parent: Node

pos

pos: number

text

text: string

TemplateSpan

TemplateSpan:

decorators

decorators: NodeArray<Decorator>

end

end: number

expression

expression: Expression

flags

flags: NodeFlags

kind

literal

modifiers

modifiers: ModifiersArray

parent

parent: Node

pos

pos: number

getChildAt

  • Parameters

    Returns Node

getChildCount

  • Parameters

    Returns number

getChildren

  • Parameters

    Returns Node[]

getEnd

  • getEnd(): number
  • Returns number

getFirstToken

getFullStart

  • getFullStart(): number
  • Returns number

getFullText

  • Parameters

    Returns string

getFullWidth

  • getFullWidth(): number
  • Returns number

getLastToken

  • Parameters

    Returns Node

getLeadingTriviaWidth

  • getLeadingTriviaWidth(sourceFile?: SourceFile): number

getSourceFile

getStart

  • Parameters

    Returns number

getText

  • Parameters

    Returns string

getWidth

  • Parameters

    Returns number

TextChangeRange

TextChangeRange:

newLength

newLength: number

span

span: TextSpan

TextInsertion

TextInsertion:

caretOffset

caretOffset: number

The position in newText the caret should point to after the insertion.

newText

newText: string

TextRange

TextRange:

end

end: number

pos

pos: number

TextSpan

TextSpan:

length

length: number

start

start: number

ThisTypeNode

ThisTypeNode:

_thisTypeNodeBrand

_thisTypeNodeBrand: any

_typeNodeBrand

_typeNodeBrand: any

decorators

decorators: NodeArray<Decorator>

end

end: number

flags

flags: NodeFlags

kind

modifiers

modifiers: ModifiersArray

parent

parent: Node

pos

pos: number

ThisTypePredicate

ThisTypePredicate:

_thisTypePredicateBrand

_thisTypePredicateBrand: any

kind

type

type: Type

ThrowStatement

ThrowStatement:

_statementBrand

_statementBrand: any

decorators

decorators: NodeArray<Decorator>

end

end: number

expression

expression: Expression

flags

flags: NodeFlags

kind

modifiers

modifiers: ModifiersArray

parent

parent: Node

pos

pos: number

TodoComment

TodoComment:

descriptor

message

message: string

position

position: number

TodoCommentDescriptor

TodoCommentDescriptor:

priority

priority: number

text

text: string

TranspileOptions

TranspileOptions:

compilerOptions

compilerOptions: CompilerOptions

fileName

fileName: string

moduleName

moduleName: string

renamedDependencies

renamedDependencies: Map<string>

reportDiagnostics

reportDiagnostics: boolean

TranspileOutput

TranspileOutput:

diagnostics

diagnostics: Diagnostic[]

outputText

outputText: string

sourceMapText

sourceMapText: string

TryStatement

TryStatement:

_statementBrand

_statementBrand: any

catchClause

catchClause: CatchClause

decorators

decorators: NodeArray<Decorator>

end

end: number

finallyBlock

finallyBlock: Block

flags

flags: NodeFlags

kind

modifiers

modifiers: ModifiersArray

parent

parent: Node

pos

pos: number

tryBlock

tryBlock: Block

TupleType

TupleType:

elementTypes

elementTypes: Type[]

flags

flags: TypeFlags

pattern

symbol

symbol: Symbol

TupleTypeNode

TupleTypeNode:

_typeNodeBrand

_typeNodeBrand: any

decorators

decorators: NodeArray<Decorator>

elementTypes

elementTypes: NodeArray<TypeNode>

end

end: number

flags

flags: NodeFlags

kind

modifiers

modifiers: ModifiersArray

parent

parent: Node

pos

pos: number

Type

Type:

flags

flags: TypeFlags

pattern

symbol

symbol: Symbol

getApparentProperties

  • getApparentProperties(): Symbol[]
  • Returns Symbol[]

getBaseTypes

  • Returns ObjectType[]

getCallSignatures

  • Returns Signature[]

getConstructSignatures

  • Returns Signature[]

getFlags

  • Returns TypeFlags

getNumberIndexType

  • getNumberIndexType(): Type
  • Returns Type

getProperties

  • Returns Symbol[]

getProperty

  • getProperty(propertyName: string): Symbol
  • Parameters

    • propertyName: string

    Returns Symbol

getStringIndexType

  • getStringIndexType(): Type
  • Returns Type

getSymbol

  • Returns Symbol

TypeAliasDeclaration

TypeAliasDeclaration:

_declarationBrand

_declarationBrand: any

_statementBrand

_statementBrand: any

decorators

decorators: NodeArray<Decorator>

end

end: number

flags

flags: NodeFlags

kind

modifiers

modifiers: ModifiersArray

name

parent

parent: Node

pos

pos: number

type

type: TypeNode

typeParameters

TypeAssertion

TypeAssertion:

_expressionBrand

_expressionBrand: any

_unaryExpressionBrand

_unaryExpressionBrand: any

contextualType

contextualType: Type

decorators

decorators: NodeArray<Decorator>

end

end: number

expression

expression: UnaryExpression

flags

flags: NodeFlags

kind

modifiers

modifiers: ModifiersArray

parent

parent: Node

pos

pos: number

type

type: TypeNode

TypeChecker

TypeChecker:

getAliasedSymbol

  • Parameters

    Returns Symbol

getAugmentedPropertiesOfType

  • getAugmentedPropertiesOfType(type: Type): Symbol[]
  • Parameters

    Returns Symbol[]

getBaseTypes

getConstantValue

getContextualType

  • Parameters

    Returns Type

getDeclaredTypeOfSymbol

  • Parameters

    Returns Type

getExportSpecifierLocalTargetSymbol

  • Parameters

    Returns Symbol

getExportsOfModule

  • Parameters

    Returns Symbol[]

getFullyQualifiedName

  • getFullyQualifiedName(symbol: Symbol): string
  • Parameters

    Returns string

getIndexTypeOfType

  • Parameters

    Returns Type

getJsxElementAttributesType

getJsxIntrinsicTagNames

  • getJsxIntrinsicTagNames(): Symbol[]
  • Returns Symbol[]

getPropertiesOfType

  • Parameters

    Returns Symbol[]

getPropertyOfType

  • getPropertyOfType(type: Type, propertyName: string): Symbol
  • Parameters

    • type: Type
    • propertyName: string

    Returns Symbol

getResolvedSignature

getReturnTypeOfSignature

  • Parameters

    Returns Type

getRootSymbols

  • Parameters

    Returns Symbol[]

getShorthandAssignmentValueSymbol

  • getShorthandAssignmentValueSymbol(location: Node): Symbol
  • Parameters

    Returns Symbol

getSignatureFromDeclaration

getSignaturesOfType

getSymbolAtLocation

  • Parameters

    Returns Symbol

getSymbolDisplayBuilder

getSymbolsInScope

  • Parameters

    Returns Symbol[]

getSymbolsOfParameterPropertyDeclaration

  • Parameters

    Returns Symbol[]

getTypeAtLocation

  • Parameters

    Returns Type

getTypeOfSymbolAtLocation

  • Parameters

    Returns Type

isArgumentsSymbol

  • isArgumentsSymbol(symbol: Symbol): boolean
  • Parameters

    Returns boolean

isImplementationOfOverload

  • Parameters

    Returns boolean

isOptionalParameter

  • Parameters

    Returns boolean

isUndefinedSymbol

  • isUndefinedSymbol(symbol: Symbol): boolean
  • Parameters

    Returns boolean

isUnknownSymbol

  • isUnknownSymbol(symbol: Symbol): boolean
  • Parameters

    Returns boolean

isValidPropertyAccess

symbolToString

  • Parameters

    Returns string

typeToString

  • Parameters

    Returns string

TypeElement

TypeElement:

_declarationBrand

_declarationBrand: any

_typeElementBrand

_typeElementBrand: any

decorators

decorators: NodeArray<Decorator>

end

end: number

flags

flags: NodeFlags

kind

modifiers

modifiers: ModifiersArray

name

parent

parent: Node

pos

pos: number

questionToken

questionToken: Node

TypeLiteralNode

TypeLiteralNode:

_declarationBrand

_declarationBrand: any

_typeNodeBrand

_typeNodeBrand: any

decorators

decorators: NodeArray<Decorator>

end

end: number

flags

flags: NodeFlags

kind

members

modifiers

modifiers: ModifiersArray

name

parent

parent: Node

pos

pos: number

TypeNode

TypeNode:

_typeNodeBrand

_typeNodeBrand: any

decorators

decorators: NodeArray<Decorator>

end

end: number

flags

flags: NodeFlags

kind

modifiers

modifiers: ModifiersArray

parent

parent: Node

pos

pos: number

getChildAt

  • Parameters

    Returns Node

getChildCount

  • Parameters

    Returns number

getChildren

  • Parameters

    Returns Node[]

getEnd

  • getEnd(): number
  • Returns number

getFirstToken

getFullStart

  • getFullStart(): number
  • Returns number

getFullText

  • Parameters

    Returns string

getFullWidth

  • getFullWidth(): number
  • Returns number

getLastToken

  • Parameters

    Returns Node

getLeadingTriviaWidth

  • getLeadingTriviaWidth(sourceFile?: SourceFile): number

getSourceFile

getStart

  • Parameters

    Returns number

getText

  • Parameters

    Returns string

getWidth

  • Parameters

    Returns number

TypeOfExpression

TypeOfExpression:

_expressionBrand

_expressionBrand: any

_unaryExpressionBrand

_unaryExpressionBrand: any

contextualType

contextualType: Type

decorators

decorators: NodeArray<Decorator>

end

end: number

expression

expression: UnaryExpression

flags

flags: NodeFlags

kind

modifiers

modifiers: ModifiersArray

parent

parent: Node

pos

pos: number

TypeParameter

TypeParameter:

constraint

constraint: Type

flags

flags: TypeFlags

pattern

symbol

symbol: Symbol

getApparentProperties

  • getApparentProperties(): Symbol[]

getBaseTypes

getCallSignatures

getConstructSignatures

getFlags

  • Returns TypeFlags

getNumberIndexType

  • getNumberIndexType(): Type

getProperties

getProperty

  • getProperty(propertyName: string): Symbol
  • Parameters

    • propertyName: string

    Returns Symbol

getStringIndexType

  • getStringIndexType(): Type

getSymbol

  • Returns Symbol

TypeParameterDeclaration

TypeParameterDeclaration:

_declarationBrand

_declarationBrand: any

constraint

constraint: TypeNode

decorators

decorators: NodeArray<Decorator>

end

end: number

expression

expression: Expression

flags

flags: NodeFlags

kind

modifiers

modifiers: ModifiersArray

name

parent

parent: Node

pos

pos: number

TypePredicateBase

TypePredicateBase:

kind

type

type: Type

TypePredicateNode

TypePredicateNode:

_typeNodeBrand

_typeNodeBrand: any

decorators

decorators: NodeArray<Decorator>

end

end: number

flags

flags: NodeFlags

kind

modifiers

modifiers: ModifiersArray

parameterName

parameterName: Identifier | ThisTypeNode

parent

parent: Node

pos

pos: number

type

type: TypeNode

TypeQueryNode

TypeQueryNode:

_typeNodeBrand

_typeNodeBrand: any

decorators

decorators: NodeArray<Decorator>

end

end: number

exprName

exprName: EntityName

flags

flags: NodeFlags

kind

modifiers

modifiers: ModifiersArray

parent

parent: Node

pos

pos: number

TypeReference

TypeReference:

flags

flags: TypeFlags

pattern

symbol

symbol: Symbol

target

target: GenericType

typeArguments

typeArguments: Type[]

TypeReferenceNode

TypeReferenceNode:

_typeNodeBrand

_typeNodeBrand: any

decorators

decorators: NodeArray<Decorator>

end

end: number

flags

flags: NodeFlags

kind

modifiers

modifiers: ModifiersArray

parent

parent: Node

pos

pos: number

typeArguments

typeArguments: NodeArray<TypeNode>

typeName

typeName: EntityName

UnaryExpression

UnaryExpression:

_expressionBrand

_expressionBrand: any

_unaryExpressionBrand

_unaryExpressionBrand: any

contextualType

contextualType: Type

decorators

decorators: NodeArray<Decorator>

end

end: number

flags

flags: NodeFlags

kind

modifiers

modifiers: ModifiersArray

parent

parent: Node

pos

pos: number

UnionOrIntersectionType

UnionOrIntersectionType:

flags

flags: TypeFlags

pattern

symbol

symbol: Symbol

types

types: Type[]

getApparentProperties

  • getApparentProperties(): Symbol[]

getBaseTypes

getCallSignatures

getConstructSignatures

getFlags

  • Returns TypeFlags

getNumberIndexType

  • getNumberIndexType(): Type

getProperties

getProperty

  • getProperty(propertyName: string): Symbol
  • Parameters

    • propertyName: string

    Returns Symbol

getStringIndexType

  • getStringIndexType(): Type

getSymbol

  • Returns Symbol

UnionOrIntersectionTypeNode

UnionOrIntersectionTypeNode:

_typeNodeBrand

_typeNodeBrand: any

decorators

decorators: NodeArray<Decorator>

end

end: number

flags

flags: NodeFlags

kind

modifiers

modifiers: ModifiersArray

parent

parent: Node

pos

pos: number

types

UnionType

UnionType:

flags

flags: TypeFlags

pattern

symbol

symbol: Symbol

types

types: Type[]

UnionTypeNode

UnionTypeNode:

_typeNodeBrand

_typeNodeBrand: any

decorators

decorators: NodeArray<Decorator>

end

end: number

flags

flags: NodeFlags

kind

modifiers

modifiers: ModifiersArray

parent

parent: Node

pos

pos: number

types

VariableDeclaration

VariableDeclaration:

_declarationBrand

_declarationBrand: any

decorators

decorators: NodeArray<Decorator>

end

end: number

flags

flags: NodeFlags

initializer

initializer: Expression

kind

modifiers

modifiers: ModifiersArray

name

parent

pos

pos: number

type

type: TypeNode

VariableDeclarationList

VariableDeclarationList:

declarations

decorators

decorators: NodeArray<Decorator>

end

end: number

flags

flags: NodeFlags

kind

modifiers

modifiers: ModifiersArray

parent

parent: Node

pos

pos: number

getChildAt

  • Parameters

    Returns Node

getChildCount

  • Parameters

    Returns number

getChildren

  • Parameters

    Returns Node[]

getEnd

  • getEnd(): number
  • Returns number

getFirstToken

getFullStart

  • getFullStart(): number
  • Returns number

getFullText

  • Parameters

    Returns string

getFullWidth

  • getFullWidth(): number
  • Returns number

getLastToken

  • Parameters

    Returns Node

getLeadingTriviaWidth

  • getLeadingTriviaWidth(sourceFile?: SourceFile): number

getSourceFile

getStart

  • Parameters

    Returns number

getText

  • Parameters

    Returns string

getWidth

  • Parameters

    Returns number

VariableLikeDeclaration

VariableLikeDeclaration:

_declarationBrand

_declarationBrand: any

decorators

decorators: NodeArray<Decorator>

dotDotDotToken

dotDotDotToken: Node

end

end: number

flags

flags: NodeFlags

initializer

initializer: Expression

kind

modifiers

modifiers: ModifiersArray

name

parent

parent: Node

pos

pos: number

propertyName

propertyName: PropertyName

questionToken

questionToken: Node

type

type: TypeNode

VariableStatement

VariableStatement:

_statementBrand

_statementBrand: any

declarationList

declarationList: VariableDeclarationList

decorators

decorators: NodeArray<Decorator>

end

end: number

flags

flags: NodeFlags

kind

modifiers

modifiers: ModifiersArray

parent

parent: Node

pos

pos: number

VoidExpression

VoidExpression:

_expressionBrand

_expressionBrand: any

_unaryExpressionBrand

_unaryExpressionBrand: any

contextualType

contextualType: Type

decorators

decorators: NodeArray<Decorator>

end

end: number

expression

expression: UnaryExpression

flags

flags: NodeFlags

kind

modifiers

modifiers: ModifiersArray

parent

parent: Node

pos

pos: number

WhileStatement

WhileStatement:

_statementBrand

_statementBrand: any

decorators

decorators: NodeArray<Decorator>

end

end: number

expression

expression: Expression

flags

flags: NodeFlags

kind

modifiers

modifiers: ModifiersArray

parent

parent: Node

pos

pos: number

statement

statement: Statement

WithStatement

WithStatement:

_statementBrand

_statementBrand: any

decorators

decorators: NodeArray<Decorator>

end

end: number

expression

expression: Expression

flags

flags: NodeFlags

kind

modifiers

modifiers: ModifiersArray

parent

parent: Node

pos

pos: number

statement

statement: Statement

WriteFileCallback

  • __call(fileName: string, data: string, writeByteOrderMark: boolean, onError?: function): void
  • Parameters

    • fileName: string
    • data: string
    • writeByteOrderMark: boolean
    • Optional onError: function
        • (message: string): void
        • Parameters

          • message: string

          Returns void

    Returns void

YieldExpression

YieldExpression:

_expressionBrand

_expressionBrand: any

asteriskToken

asteriskToken: Node

contextualType

contextualType: Type

decorators

decorators: NodeArray<Decorator>

end

end: number

expression

expression: Expression

flags

flags: NodeFlags

kind

modifiers

modifiers: ModifiersArray

parent

parent: Node

pos

pos: number

AssertionExpression

AssertionExpression: TypeAssertion | AsExpression

BlockLike

BreakOrContinueStatement

BreakOrContinueStatement: BreakStatement | ContinueStatement

CallLikeExpression

CaseOrDefaultClause

CaseOrDefaultClause: CaseClause | DefaultClause

ConciseBody

ConciseBody: FunctionBody | Expression

DeclarationName

DestructuringPattern

DirectoryWatcherCallback

DirectoryWatcherCallback: function

Type declaration

    • (path: string): void
    • Parameters

      • path: string

      Returns void

EntityName

FileWatcherCallback

FileWatcherCallback: function

Type declaration

    • (path: string, removed?: boolean): void
    • Parameters

      • path: string
      • Optional removed: boolean

      Returns void

FunctionBody

FunctionBody: Block

ImportOrExportSpecifier

ImportOrExportSpecifier: ImportSpecifier | ExportSpecifier

JSDocTypeReferencingNode

JsxChild

JsxOpeningLikeElement

JsxOpeningLikeElement: JsxSelfClosingElement | JsxOpeningElement

ModuleBody

NamedImportsOrExports

NamedImportsOrExports: NamedImports | NamedExports

Path

Path: string & { __pathBrand: any; }

PropertyName

TypePredicate

disableIncrementalParsing

disableIncrementalParsing: boolean

servicesVersion

servicesVersion: string

The version of the language service API

sys

sys: System

unchangedTextChangeRange

unchangedTextChangeRange: TextChangeRange

version

version: string

classicNameResolver

collapseTextChangeRangesAcrossMultipleVersions

  • Called to merge all the changes that occurred across several versions of a script snapshot into a single change. i.e. if a user keeps making successive edits to a script we will have a text change from V1 to V2, V2 to V3, ..., Vn.

    This function will then merge those changes into a single change range valid between V1 and Vn.

    Parameters

    Returns TextChangeRange

convertCompilerOptionsFromJson

  • convertCompilerOptionsFromJson(jsonOptions: any, basePath: string, configFileName?: string): object
  • Parameters

    • jsonOptions: any
    • basePath: string
    • Optional configFileName: string

    Returns object

couldStartTrivia

  • couldStartTrivia(text: string, pos: number): boolean
  • Parameters

    • text: string
    • pos: number

    Returns boolean

createClassifier

  • Returns Classifier

createCompilerHost

  • Parameters

    Returns CompilerHost

createDocumentRegistry

  • createDocumentRegistry(useCaseSensitiveFileNames?: boolean, currentDirectory?: string): DocumentRegistry
  • Parameters

    • Optional useCaseSensitiveFileNames: boolean
    • Optional currentDirectory: string

    Returns DocumentRegistry

createLanguageService

createLanguageServiceSourceFile

  • Parameters

    Returns SourceFile

createNode

  • Parameters

    • kind: SyntaxKind
    • Optional pos: number
    • Optional end: number

    Returns Node

createProgram

createScanner

  • Parameters

    Returns Scanner

createSourceFile

  • createSourceFile(fileName: string, sourceText: string, languageVersion: ScriptTarget, setParentNodes?: boolean): SourceFile
  • Parameters

    • fileName: string
    • sourceText: string
    • languageVersion: ScriptTarget
    • Optional setParentNodes: boolean

    Returns SourceFile

createTextChangeRange

  • Parameters

    Returns TextChangeRange

createTextSpan

  • createTextSpan(start: number, length: number): TextSpan
  • Parameters

    • start: number
    • length: number

    Returns TextSpan

createTextSpanFromBounds

  • createTextSpanFromBounds(start: number, end: number): TextSpan
  • Parameters

    • start: number
    • end: number

    Returns TextSpan

decodedTextSpanIntersectsWith

  • decodedTextSpanIntersectsWith(start1: number, length1: number, start2: number, length2: number): boolean
  • Parameters

    • start1: number
    • length1: number
    • start2: number
    • length2: number

    Returns boolean

displayPartsToString

  • Parameters

    Returns string

findConfigFile

  • findConfigFile(searchPath: string, fileExists: function): string
  • Parameters

    • searchPath: string
    • fileExists: function
        • (fileName: string): boolean
        • Parameters

          • fileName: string

          Returns boolean

    Returns string

flattenDiagnosticMessageText

  • Parameters

    Returns string

forEachChild

  • forEachChild<T>(node: Node, cbNode: function, cbNodeArray?: function): T
  • Type parameters

    • T

    Parameters

    • node: Node
    • cbNode: function
        • Parameters

          Returns T

    • Optional cbNodeArray: function
        • (nodes: Node[]): T
        • Parameters

          Returns T

    Returns T

getDefaultCompilerOptions

  • Returns CompilerOptions

getDefaultLibFileName

  • Parameters

    Returns string

getDefaultLibFilePath

  • Get the path of the default library files (lib.d.ts) as distributed with the typescript node package. The functionality is not supported if the ts module is consumed outside of a node module.

    Parameters

    Returns string

getLeadingCommentRanges

  • getLeadingCommentRanges(text: string, pos: number): CommentRange[]
  • Parameters

    • text: string
    • pos: number

    Returns CommentRange[]

getLineAndCharacterOfPosition

  • Parameters

    Returns LineAndCharacter

getPositionOfLineAndCharacter

  • getPositionOfLineAndCharacter(sourceFile: SourceFile, line: number, character: number): number
  • Parameters

    • sourceFile: SourceFile
    • line: number
    • character: number

    Returns number

getPreEmitDiagnostics

getShebang

  • getShebang(text: string): string
  • Optionally, get the shebang

    Parameters

    • text: string

    Returns string

getTrailingCommentRanges

  • getTrailingCommentRanges(text: string, pos: number): CommentRange[]
  • Parameters

    • text: string
    • pos: number

    Returns CommentRange[]

getTypeParameterOwner

isIdentifierPart

  • isIdentifierPart(ch: number, languageVersion: ScriptTarget): boolean
  • Parameters

    Returns boolean

isIdentifierStart

  • isIdentifierStart(ch: number, languageVersion: ScriptTarget): boolean
  • Parameters

    Returns boolean

isLineBreak

  • isLineBreak(ch: number): boolean
  • Parameters

    • ch: number

    Returns boolean

isParameterPropertyDeclaration

  • Parameters

    Returns boolean

isWhiteSpace

  • isWhiteSpace(ch: number): boolean
  • Parameters

    • ch: number

    Returns boolean

nodeModuleNameResolver

parseCommandLine

  • Parameters

    • commandLine: string[]
    • Optional readFile: function
        • (path: string): string
        • Parameters

          • path: string

          Returns string

    Returns ParsedCommandLine

parseConfigFileTextToJson

  • parseConfigFileTextToJson(fileName: string, jsonText: string): object
  • Parse the text of the tsconfig.json file

    Parameters

    • fileName: string

      The path to the config file

    • jsonText: string

      The text of the config file

    Returns object

    • Optional config?: any
    • Optional error?: Diagnostic

parseJsonConfigFileContent

  • Parse the contents of a config file (tsconfig.json).

    Parameters

    • json: any

      The contents of the config file to parse

    • host: ParseConfigHost

      Instance of ParseConfigHost used to enumerate files in folder.

    • basePath: string

      A root directory to resolve relative path entries in the config file to. e.g. outDir

    • Optional existingOptions: CompilerOptions
    • Optional configFileName: string

    Returns ParsedCommandLine

preProcessFile

  • preProcessFile(sourceText: string, readImportFiles?: boolean, detectJavaScriptImports?: boolean): PreProcessedFileInfo
  • Parameters

    • sourceText: string
    • Optional readImportFiles: boolean
    • Optional detectJavaScriptImports: boolean

    Returns PreProcessedFileInfo

readConfigFile

  • readConfigFile(fileName: string, readFile: function): object
  • Read tsconfig.json file

    Parameters

    • fileName: string

      The path to the config file

    • readFile: function
        • (path: string): string
        • Parameters

          • path: string

          Returns string

    Returns object

    • Optional config?: any
    • Optional error?: Diagnostic

resolveModuleName

resolveTripleslashReference

  • resolveTripleslashReference(moduleName: string, containingFile: string): string
  • Parameters

    • moduleName: string
    • containingFile: string

    Returns string

textChangeRangeIsUnchanged

  • Parameters

    Returns boolean

textChangeRangeNewSpan

textSpanContainsPosition

  • textSpanContainsPosition(span: TextSpan, position: number): boolean
  • Parameters

    Returns boolean

textSpanContainsTextSpan

  • Parameters

    Returns boolean

textSpanEnd

  • Parameters

    Returns number

textSpanIntersection

  • Parameters

    Returns TextSpan

textSpanIntersectsWith

  • textSpanIntersectsWith(span: TextSpan, start: number, length: number): boolean
  • Parameters

    • span: TextSpan
    • start: number
    • length: number

    Returns boolean

textSpanIntersectsWithPosition

  • textSpanIntersectsWithPosition(span: TextSpan, position: number): boolean
  • Parameters

    Returns boolean

textSpanIntersectsWithTextSpan

  • Parameters

    Returns boolean

textSpanIsEmpty

  • textSpanIsEmpty(span: TextSpan): boolean
  • Parameters

    Returns boolean

textSpanOverlap

  • Parameters

    Returns TextSpan

textSpanOverlapsWith

  • Parameters

    Returns boolean

tokenToString

  • Parameters

    Returns string

transpile

  • transpile(input: string, compilerOptions?: CompilerOptions, fileName?: string, diagnostics?: Diagnostic[], moduleName?: string): string
  • Parameters

    • input: string
    • Optional compilerOptions: CompilerOptions
    • Optional fileName: string
    • Optional diagnostics: Diagnostic[]
    • Optional moduleName: string

    Returns string

transpileModule

updateLanguageServiceSourceFile

updateSourceFile

  • Parameters

    Returns SourceFile

"src/apply-visitor"

"src/apply-visitor":

ApplyVisitorResult

ApplyVisitorResult:

actions

actions: Action[]

code

code: string

diags

diags: Diagnostic[]

file

applyVisitor

applyVisitorOnAst

applyVisitorOnHostedSource

"src/binary-search"

"src/binary-search":

default

  • default(array: number[], value: number): number

"src/chainable-hosts"

"src/chainable-hosts":

AstCacheHost

AstCacheHost:

cache

cache: object

Type declaration

source

source: CompilerHost

fileExists

  • fileExists(fileName: string): boolean

getCancellationToken

getCanonicalFileName

  • getCanonicalFileName(fileName: string): string

getCurrentDirectory

  • getCurrentDirectory(): string

getDefaultLibFileName

getNewLine

  • getNewLine(): string

getSourceFile

readFile

  • readFile(fileName: string): string

setSource

useCaseSensitiveFileNames

  • useCaseSensitiveFileNames(): boolean

writeFile

  • writeFile(name: string, text: string, writeByteOrderMark: boolean): void

SemanticHost

SemanticHost:

constructor

compilerOptions

compilerOptions: CompilerOptions

files

files: string[]

source

source: CompilerHost

acquireDocument

directoryExists

  • directoryExists(directoryName: string): boolean

error

  • error(s: string): void

fileExists

  • fileExists(fileName: string): boolean

getCancellationToken

getCanonicalFileName

  • getCanonicalFileName(fileName: string): string

getCompilationSettings

getCurrentDirectory

  • getCurrentDirectory(): string

getDefaultLibFileName

getLocalizedDiagnosticMessages

  • getLocalizedDiagnosticMessages(): any

getNewLine

  • getNewLine(): string

getProjectVersion

  • getProjectVersion(): string

getScriptFileNames

  • getScriptFileNames(): string[]

getScriptSnapshot

getScriptVersion

  • getScriptVersion(fileName: string): string

getSourceFile

log

  • log(s: string): void

readFile

  • readFile(fileName: string): string

releaseDocument

  • releaseDocument(fileName: string, compilationSettings: CompilerOptions): void
  • Informs the DocumentRegistry that a file is not needed any longer.

    Note: It is not allowed to call release on a SourceFile that was not acquired from this registry originally.

    Parameters

    • fileName: string

      The name of the file to be released

    • compilationSettings: CompilerOptions

      The compilation settings used to acquire the file

    Returns void

reportStats

  • reportStats(): string

resolveModuleNames

  • resolveModuleNames(moduleNames: string[], containingFile: string): ResolvedModule[]

setSource

trace

  • trace(s: string): void

tryResolveFileName

  • tryResolveFileName(candidate: string): string

updateDocument

  • Request an updated version of an already existing SourceFile with a given fileName and compilationSettings. The update will in-turn call updateLanguageServiceSourceFile to get an updated SourceFile.

    Parameters

    • fileName: string

      The name of the file requested

    • compilationSettings: CompilerOptions

      Some compilation settings like target affects the shape of a the resulting SourceFile. This allows the DocumentRegistry to store multiple copies of the same file for different compilation settings.

    • scriptSnapshot: IScriptSnapshot

      Text of the file.

    • version: string

      Current version of the file.

    Returns SourceFile

useCaseSensitiveFileNames

  • useCaseSensitiveFileNames(): boolean

writeFile

  • writeFile(name: string, text: string, writeByteOrderMark: boolean): void

TransformationHost

TransformationHost:

constructor

source

source: CompilerHost

transformations

transformations: object

Type declaration

transformer

transformer: CodeTransformer

fileExists

  • fileExists(fileName: string): boolean

getCancellationToken

getCanonicalFileName

  • getCanonicalFileName(fileName: string): string

getCurrentDirectory

  • getCurrentDirectory(): string

getDefaultLibFileName

getNewLine

  • getNewLine(): string

getSourceFile

getSourceMap

readFile

  • readFile(fileName: string): string

setSource

translateDiagnostic

useCaseSensitiveFileNames

  • useCaseSensitiveFileNames(): boolean

writeFile

  • writeFile(name: string, text: string, writeByteOrderMark: boolean): void

combinePaths

combinePaths: function

Type declaration

    • (path1: string, path2: string): string
    • Parameters

      • path1: string
      • path2: string

      Returns string

getDirectoryPath

getDirectoryPath: function

Type declaration

    • (path: string): string
    • Parameters

      • path: string

      Returns string

normalizePath

normalizePath: function

Type declaration

    • (path: string): string
    • Parameters

      • path: string

      Returns string

"src/configuration"

"src/configuration":

defaultCompilerOptions

defaultCompilerOptions: object

emitDecoratorMetadata

emitDecoratorMetadata: boolean

experimentalDecorators

experimentalDecorators: boolean

inlineSources

inlineSources: boolean

jsx

jsx: JsxEmit

module

module: ModuleKind

noEmitHelpers

noEmitHelpers: boolean

preserveConstEnums

preserveConstEnums: boolean

sourceMap

sourceMap: boolean

target

target: ScriptTarget

"src/hosts"

"src/hosts":

MultipleFilesHost

MultipleFilesHost:

constructor

_compilerOptions

_compilerOptions: CompilerOptions

_resolutionHosts

_resolutionHosts: ModuleResolutionHost[]

syntacticErrors

syntacticErrors: Diagnostic[]

fileExists

  • fileExists(fileName: string): boolean

getCancellationToken

getCanonicalFileName

  • getCanonicalFileName(fileName: string): string

getCurrentDirectory

  • getCurrentDirectory(): string

getDefaultLibFileName

getNewLine

  • getNewLine(): string

getParserErrors

getSourceFile

getSyntacticErrors

readFile

  • readFile(fileName: string): string

useCaseSensitiveFileNames

  • useCaseSensitiveFileNames(): boolean

writeFile

  • writeFile(name: string, text: string, writeByteOrderMark: boolean): void

SingleFileHost

SingleFileHost:

constructor

_ast

_map

_map: string

_output

_output: string

output

output:

sourceMap

sourceMap:

fileExists

  • fileExists(fileName: string): boolean

getCancellationToken

getCanonicalFileName

  • getCanonicalFileName(fileName: string): string

getCurrentDirectory

  • getCurrentDirectory(): string

getDefaultLibFileName

getNewLine

  • getNewLine(): string

getSourceFile

readFile

  • readFile(fileName: string): string

useCaseSensitiveFileNames

  • useCaseSensitiveFileNames(): boolean

writeFile

  • writeFile(name: string, text: string, writeByteOrderMark: boolean): void

fileExtensionIs

  • fileExtensionIs(path: string, extension: string): boolean
  • Parameters

    • path: string
    • extension: string

    Returns boolean

"src/hosts-base"

"src/hosts-base":

ChainableHost

ChainableHost:

source

source: CompilerHost

fileExists

  • fileExists(fileName: string): boolean

getCancellationToken

getCanonicalFileName

  • getCanonicalFileName(fileName: string): string

getCurrentDirectory

  • getCurrentDirectory(): string

getDefaultLibFileName

getNewLine

  • getNewLine(): string

getSourceFile

readFile

  • readFile(fileName: string): string

setSource

useCaseSensitiveFileNames

  • useCaseSensitiveFileNames(): boolean

writeFile

  • writeFile(name: string, text: string, writeByteOrderMark: boolean): void

HostBase

HostBase:

fileExists

  • fileExists(fileName: string): boolean

getCancellationToken

getCanonicalFileName

  • getCanonicalFileName(fileName: string): string

getCurrentDirectory

  • getCurrentDirectory(): string

getDefaultLibFileName

getNewLine

  • getNewLine(): string

getSourceFile

readFile

  • readFile(fileName: string): string

useCaseSensitiveFileNames

  • useCaseSensitiveFileNames(): boolean

writeFile

  • writeFile(name: string, text: string, writeByteOrderMark: boolean): void
  • Parameters

    • name: string
    • text: string
    • writeByteOrderMark: boolean

    Returns void

chainHosts

"src/index"

"src/index":

"src/mutable-source-code"

"src/mutable-source-code":

FastAction

FastAction:

execute

FastAppendAction

FastAppendAction:

constructor

str

str: string

execute

FastRewriteAction

FastRewriteAction:

constructor

start

start: number

str

str: string

execute

InsertAction

InsertAction:

constructor

  • new InsertAction(start: number, str: string): InsertAction

start

start: number

str

str: string

execute

getStart

  • getStart(): number

MappedAction

MappedAction:

execute

getStart

  • getStart(): number

MutableSourceCode

MutableSourceCode:

constructor

_ast

_sourceMap

_sourceMap: RawSourceMap

magicString

magicString: MagicString

origLineStarts

origLineStarts: number[]

originalText

originalText: string

ast

ast:

code

code:

sourceMap

sourceMap:

execute

  • execute(actionList: Array<Action>): void

translateDiagnostic

translateMap

ReplaceAction

ReplaceAction:

constructor

  • new ReplaceAction(start: number, end: number, str: string): ReplaceAction

end

end: number

start

start: number

str

str: string

execute

getStart

  • getStart(): number

Action

compareActions

"src/transformer"

"src/transformer":

VisitorBasedTransformer

VisitorBasedTransformer:

constructor

languageServiceProvider

languageServiceProvider: function

Type declaration

visitors

visitors: Visitor[]

transform

CodeTransformer

CodeTransformer:

transform

"src/transpile"

"src/transpile":

TranspilerConfig

TranspilerConfig:

compilerOptions

compilerOptions: CompilerOptions

sourceFileName

sourceFileName: string

visitors

visitors: Visitor[]

TranspilerOutput

TranspilerOutput:

result of transpilation action

code

code: string

the transpiled code, if transpilation was not halted

diags

diags: Diagnostic[]

diagnostics produced by Typescript or the visitors

halted

halted: boolean

did the transpilation fail

sourceMap

sourceMap: RawSourceMap

a raw sourcemap object representing all changes made from the supplied source to the transpiled code (visitors and typescript alike)

ValidatorConfig

ValidatorConfig:

mutators

mutators: Visitor[]

resolutionHosts

resolutionHosts: ModuleResolutionHost[]

visitors

visitors: Visitor[]

getParserErrors

transpile

validateAll

"src/transpiler-context"

"src/transpiler-context":

TranspilerContext

TranspilerContext:

constructor

  • new TranspilerContext(_fileName: string, langServiceProvider?: function): TranspilerContext

_actions

_actions: Action[]

_diags

_diags: Diagnostic[]

_fileName

_fileName: string

_halted

_halted: boolean

langServiceProvider

langServiceProvider: function

Type declaration

actions

actions:

diags

diags:

fileName

fileName:

halted

halted:

fastAppend

  • fastAppend(str: string): void

fastRewrite

  • fastRewrite(start: number, str: string): void

getLanguageService

insert

  • insert(position: number, str: string): void

insertLine

  • insertLine(position: number, str: string): void

isHalted

  • isHalted(): boolean

pushDiag

replace

  • replace(start: number, end: number, str: string): void

reportDiag

"src/traverse-ast"

"src/traverse-ast":

descend

traverseAst

"src/visitor"

"src/visitor":

Visitor

Visitor:

single unit of transpilation logic

filter

  • filter(node: Node): boolean
  • predicate defining whether this visitor should operate on this node

    Parameters

    • node: Node

      typescript AST node

    Returns boolean

visit

  • perform visitor logic on given node

    Parameters

    • node: Node

      typescript AST node for which filter(node) returnes true

    • context: VisitorContext

      transpilation actions handler for the current visit

    • traverse: function
        • Parameters

          Returns void

    Returns void

VisitorContext

VisitorContext:

a transpilation actions API supplied to Visitor at visit time

fileName

fileName: string

halted

halted: boolean

was the transpilation declared as failed by any previous visitor

fastAppend

  • fastAppend(str: string): void

fastRewrite

  • fastRewrite(start: number, str: string): void

getLanguageService

insert

  • insert(position: number, str: string): void
  • insert text at given position

    Parameters

    • position: number

      position in code at which to insert line.

    • str: string

      text to insert

    Returns void

insertLine

  • insertLine(position: number, str: string): void
  • add a text line at given position

    Parameters

    • position: number

      position in code at which to insert line.

    • str: string

      line to insert

    Returns void

replace

  • replace(start: number, end: number, str: string): void
  • replace a piece of text in the code with a given new text

    Parameters

    • start: number

      position in code of the first character to replace

    • end: number

      position in code of the last character to replace. has to be greater or equal to the start param.

    • str: string

      replacement string to insert instead of original state

    Returns void

reportDiag

  • report transpilation diagnostics

    Parameters

    • node: Node

      typescript AST node that relats to this diagnostic

    • category: DiagnosticCategory

      severity of the diagnostic to report (could be error, warning or message)

    • message: string

      txt of the diagnostic

    • Optional halt: boolean

      if true, the transpilation is declared as failed

    Returns void

"typings/main.d"

"typings/main.d":

"typings/main/ambient/chai/index.d"

"typings/main/ambient/chai/index.d":

"chai"

"chai":

Chai

Chai:

AssertionError

AssertionError:

constructor

  • new AssertionError(message: string, _props?: any, ssf?: Function): AssertionError
  • Parameters

    • message: string
    • Optional _props: any
    • Optional ssf: Function

    Returns AssertionError

message

message: string

name

name: string

showDiff

showDiff: boolean

stack

stack: string

Assert

  • __call(expression: any, message?: string): void
  • Parameters

    • expression: any

      Expression to test for truthiness.

    • Optional message: string

      Message to display on error.

    Returns void

Throw

  • Throw(fn: Function, msg?: string): void
  • Throw(fn: Function, regExp: RegExp): void
  • Throw(fn: Function, errType: Function, msg?: string): void
  • Throw(fn: Function, errType: Function, regExp: RegExp): void
  • Parameters

    • fn: Function
    • Optional msg: string

    Returns void

  • Parameters

    • fn: Function
    • regExp: RegExp

    Returns void

  • Parameters

    • fn: Function
    • errType: Function
    • Optional msg: string

    Returns void

  • Parameters

    • fn: Function
    • errType: Function
    • regExp: RegExp

    Returns void

closeTo

  • closeTo(act: number, exp: number, delta: number, msg?: string): void
  • Parameters

    • act: number
    • exp: number
    • delta: number
    • Optional msg: string

    Returns void

deepEqual

  • deepEqual(act: any, exp: any, msg?: string): void
  • Parameters

    • act: any
    • exp: any
    • Optional msg: string

    Returns void

deepProperty

  • deepProperty(obj: Object, prop: string, msg?: string): void
  • Parameters

    • obj: Object
    • prop: string
    • Optional msg: string

    Returns void

deepPropertyNotVal

  • deepPropertyNotVal(obj: Object, prop: string, val: any, msg?: string): void
  • Parameters

    • obj: Object
    • prop: string
    • val: any
    • Optional msg: string

    Returns void

deepPropertyVal

  • deepPropertyVal(obj: Object, prop: string, val: any, msg?: string): void
  • Parameters

    • obj: Object
    • prop: string
    • val: any
    • Optional msg: string

    Returns void

doesNotThrow

  • doesNotThrow(fn: Function, msg?: string): void
  • doesNotThrow(fn: Function, regExp: RegExp): void
  • doesNotThrow(fn: Function, errType: Function, msg?: string): void
  • doesNotThrow(fn: Function, errType: Function, regExp: RegExp): void
  • Parameters

    • fn: Function
    • Optional msg: string

    Returns void

  • Parameters

    • fn: Function
    • regExp: RegExp

    Returns void

  • Parameters

    • fn: Function
    • errType: Function
    • Optional msg: string

    Returns void

  • Parameters

    • fn: Function
    • errType: Function
    • regExp: RegExp

    Returns void

equal

  • equal(act: any, exp: any, msg?: string): void
  • Parameters

    • act: any
    • exp: any
    • Optional msg: string

    Returns void

fail

  • fail(actual?: any, expected?: any, msg?: string, operator?: string): void
  • Parameters

    • Optional actual: any
    • Optional expected: any
    • Optional msg: string
    • Optional operator: string

    Returns void

ifError

  • ifError(val: any, msg?: string): void
  • Parameters

    • val: any
    • Optional msg: string

    Returns void

include

  • include(exp: string, inc: any, msg?: string): void
  • include(exp: any[], inc: any, msg?: string): void
  • Parameters

    • exp: string
    • inc: any
    • Optional msg: string

    Returns void

  • Parameters

    • exp: any[]
    • inc: any
    • Optional msg: string

    Returns void

includeMembers

  • includeMembers(set1: any[], set2: any[], msg?: string): void
  • Parameters

    • set1: any[]
    • set2: any[]
    • Optional msg: string

    Returns void

instanceOf

  • instanceOf(val: any, type: Function, msg?: string): void
  • Parameters

    • val: any
    • type: Function
    • Optional msg: string

    Returns void

isArray

  • isArray(val: any, msg?: string): void
  • Parameters

    • val: any
    • Optional msg: string

    Returns void

isBoolean

  • isBoolean(val: any, msg?: string): void
  • Parameters

    • val: any
    • Optional msg: string

    Returns void

isDefined

  • isDefined(val: any, msg?: string): void
  • Parameters

    • val: any
    • Optional msg: string

    Returns void

isFalse

  • isFalse(val: any, msg?: string): void
  • Parameters

    • val: any
    • Optional msg: string

    Returns void

isFunction

  • isFunction(val: any, msg?: string): void
  • Parameters

    • val: any
    • Optional msg: string

    Returns void

isNotArray

  • isNotArray(val: any, msg?: string): void
  • Parameters

    • val: any
    • Optional msg: string

    Returns void

isNotBoolean

  • isNotBoolean(val: any, msg?: string): void
  • Parameters

    • val: any
    • Optional msg: string

    Returns void

isNotFunction

  • isNotFunction(val: any, msg?: string): void
  • Parameters

    • val: any
    • Optional msg: string

    Returns void

isNotNull

  • isNotNull(val: any, msg?: string): void
  • Parameters

    • val: any
    • Optional msg: string

    Returns void

isNotNumber

  • isNotNumber(val: any, msg?: string): void
  • Parameters

    • val: any
    • Optional msg: string

    Returns void

isNotObject

  • isNotObject(val: any, msg?: string): void
  • Parameters

    • val: any
    • Optional msg: string

    Returns void

isNotString

  • isNotString(val: any, msg?: string): void
  • Parameters

    • val: any
    • Optional msg: string

    Returns void

isNull

  • isNull(val: any, msg?: string): void
  • Parameters

    • val: any
    • Optional msg: string

    Returns void

isNumber

  • isNumber(val: any, msg?: string): void
  • Parameters

    • val: any
    • Optional msg: string

    Returns void

isObject

  • isObject(val: any, msg?: string): void
  • Parameters

    • val: any
    • Optional msg: string

    Returns void

isString

  • isString(val: any, msg?: string): void
  • Parameters

    • val: any
    • Optional msg: string

    Returns void

isTrue

  • isTrue(val: any, msg?: string): void
  • Parameters

    • val: any
    • Optional msg: string

    Returns void

isUndefined

  • isUndefined(val: any, msg?: string): void
  • Parameters

    • val: any
    • Optional msg: string

    Returns void

lengthOf

  • lengthOf(exp: any, len: number, msg?: string): void
  • Parameters

    • exp: any
    • len: number
    • Optional msg: string

    Returns void

match

  • match(exp: any, re: RegExp, msg?: string): void
  • Parameters

    • exp: any
    • re: RegExp
    • Optional msg: string

    Returns void

notDeepEqual

  • notDeepEqual(act: any, exp: any, msg?: string): void
  • Parameters

    • act: any
    • exp: any
    • Optional msg: string

    Returns void

notDeepProperty

  • notDeepProperty(obj: Object, prop: string, msg?: string): void
  • Parameters

    • obj: Object
    • prop: string
    • Optional msg: string

    Returns void

notEqual

  • notEqual(act: any, exp: any, msg?: string): void
  • Parameters

    • act: any
    • exp: any
    • Optional msg: string

    Returns void

notInclude

  • notInclude(exp: string, inc: any, msg?: string): void
  • notInclude(exp: any[], inc: any, msg?: string): void
  • Parameters

    • exp: string
    • inc: any
    • Optional msg: string

    Returns void

  • Parameters

    • exp: any[]
    • inc: any
    • Optional msg: string

    Returns void

notInstanceOf

  • notInstanceOf(val: any, type: Function, msg?: string): void
  • Parameters

    • val: any
    • type: Function
    • Optional msg: string

    Returns void

notMatch

  • notMatch(exp: any, re: RegExp, msg?: string): void
  • Parameters

    • exp: any
    • re: RegExp
    • Optional msg: string

    Returns void

notOk

  • notOk(val: any, msg?: string): void
  • Parameters

    • val: any
    • Optional msg: string

    Returns void

notProperty

  • notProperty(obj: Object, prop: string, msg?: string): void
  • Parameters

    • obj: Object
    • prop: string
    • Optional msg: string

    Returns void

notStrictEqual

  • notStrictEqual(act: any, exp: any, msg?: string): void
  • Parameters

    • act: any
    • exp: any
    • Optional msg: string

    Returns void

notTypeOf

  • notTypeOf(val: any, type: string, msg?: string): void
  • Parameters

    • val: any
    • type: string
    • Optional msg: string

    Returns void

ok

  • ok(val: any, msg?: string): void
  • Parameters

    • val: any
    • Optional msg: string

    Returns void

operator

  • operator(val: any, operator: string, val2: any, msg?: string): void
  • Parameters

    • val: any
    • operator: string
    • val2: any
    • Optional msg: string

    Returns void

property

  • property(obj: Object, prop: string, msg?: string): void
  • Parameters

    • obj: Object
    • prop: string
    • Optional msg: string

    Returns void

propertyNotVal

  • propertyNotVal(obj: Object, prop: string, val: any, msg?: string): void
  • Parameters

    • obj: Object
    • prop: string
    • val: any
    • Optional msg: string

    Returns void

propertyVal

  • propertyVal(obj: Object, prop: string, val: any, msg?: string): void
  • Parameters

    • obj: Object
    • prop: string
    • val: any
    • Optional msg: string

    Returns void

sameMembers

  • sameMembers(set1: any[], set2: any[], msg?: string): void
  • Parameters

    • set1: any[]
    • set2: any[]
    • Optional msg: string

    Returns void

strictEqual

  • strictEqual(act: any, exp: any, msg?: string): void
  • Parameters

    • act: any
    • exp: any
    • Optional msg: string

    Returns void

throw

  • throw(fn: Function, msg?: string): void
  • throw(fn: Function, regExp: RegExp): void
  • throw(fn: Function, errType: Function, msg?: string): void
  • throw(fn: Function, errType: Function, regExp: RegExp): void
  • Parameters

    • fn: Function
    • Optional msg: string

    Returns void

  • Parameters

    • fn: Function
    • regExp: RegExp

    Returns void

  • Parameters

    • fn: Function
    • errType: Function
    • Optional msg: string

    Returns void

  • Parameters

    • fn: Function
    • errType: Function
    • regExp: RegExp

    Returns void

throws

  • throws(fn: Function, msg?: string): void
  • throws(fn: Function, regExp: RegExp): void
  • throws(fn: Function, errType: Function, msg?: string): void
  • throws(fn: Function, errType: Function, regExp: RegExp): void
  • Parameters

    • fn: Function
    • Optional msg: string

    Returns void

  • Parameters

    • fn: Function
    • regExp: RegExp

    Returns void

  • Parameters

    • fn: Function
    • errType: Function
    • Optional msg: string

    Returns void

  • Parameters

    • fn: Function
    • errType: Function
    • regExp: RegExp

    Returns void

typeOf

  • typeOf(val: any, type: string, msg?: string): void
  • Parameters

    • val: any
    • type: string
    • Optional msg: string

    Returns void

AssertStatic

  • __call(expression: any, message?: string): void
  • Parameters

    • expression: any

      Expression to test for truthiness.

    • Optional message: string

      Message to display on error.

    Returns void

Throw

  • Throw(fn: Function, msg?: string): void
  • Throw(fn: Function, regExp: RegExp): void
  • Throw(fn: Function, errType: Function, msg?: string): void
  • Throw(fn: Function, errType: Function, regExp: RegExp): void
  • Parameters

    • fn: Function
    • Optional msg: string

    Returns void

  • Parameters

    • fn: Function
    • regExp: RegExp

    Returns void

  • Parameters

    • fn: Function
    • errType: Function
    • Optional msg: string

    Returns void

  • Parameters

    • fn: Function
    • errType: Function
    • regExp: RegExp

    Returns void

closeTo

  • closeTo(act: number, exp: number, delta: number, msg?: string): void
  • Parameters

    • act: number
    • exp: number
    • delta: number
    • Optional msg: string

    Returns void

deepEqual

  • deepEqual(act: any, exp: any, msg?: string): void
  • Parameters

    • act: any
    • exp: any
    • Optional msg: string

    Returns void

deepProperty

  • deepProperty(obj: Object, prop: string, msg?: string): void
  • Parameters

    • obj: Object
    • prop: string
    • Optional msg: string

    Returns void

deepPropertyNotVal

  • deepPropertyNotVal(obj: Object, prop: string, val: any, msg?: string): void
  • Parameters

    • obj: Object
    • prop: string
    • val: any
    • Optional msg: string

    Returns void

deepPropertyVal

  • deepPropertyVal(obj: Object, prop: string, val: any, msg?: string): void
  • Parameters

    • obj: Object
    • prop: string
    • val: any
    • Optional msg: string

    Returns void

doesNotThrow

  • doesNotThrow(fn: Function, msg?: string): void
  • doesNotThrow(fn: Function, regExp: RegExp): void
  • doesNotThrow(fn: Function, errType: Function, msg?: string): void
  • doesNotThrow(fn: Function, errType: Function, regExp: RegExp): void
  • Parameters

    • fn: Function
    • Optional msg: string

    Returns void

  • Parameters

    • fn: Function
    • regExp: RegExp

    Returns void

  • Parameters

    • fn: Function
    • errType: Function
    • Optional msg: string

    Returns void

  • Parameters

    • fn: Function
    • errType: Function
    • regExp: RegExp

    Returns void

equal

  • equal(act: any, exp: any, msg?: string): void
  • Parameters

    • act: any
    • exp: any
    • Optional msg: string

    Returns void

fail

  • fail(actual?: any, expected?: any, msg?: string, operator?: string): void
  • Parameters

    • Optional actual: any
    • Optional expected: any
    • Optional msg: string
    • Optional operator: string

    Returns void

ifError

  • ifError(val: any, msg?: string): void
  • Parameters

    • val: any
    • Optional msg: string

    Returns void

include

  • include(exp: string, inc: any, msg?: string): void
  • include(exp: any[], inc: any, msg?: string): void
  • Parameters

    • exp: string
    • inc: any
    • Optional msg: string

    Returns void

  • Parameters

    • exp: any[]
    • inc: any
    • Optional msg: string

    Returns void

includeMembers

  • includeMembers(set1: any[], set2: any[], msg?: string): void
  • Parameters

    • set1: any[]
    • set2: any[]
    • Optional msg: string

    Returns void

instanceOf

  • instanceOf(val: any, type: Function, msg?: string): void
  • Parameters

    • val: any
    • type: Function
    • Optional msg: string

    Returns void

isArray

  • isArray(val: any, msg?: string): void
  • Parameters

    • val: any
    • Optional msg: string

    Returns void

isBoolean

  • isBoolean(val: any, msg?: string): void
  • Parameters

    • val: any
    • Optional msg: string

    Returns void

isDefined

  • isDefined(val: any, msg?: string): void
  • Parameters

    • val: any
    • Optional msg: string

    Returns void

isFalse

  • isFalse(val: any, msg?: string): void
  • Parameters

    • val: any
    • Optional msg: string

    Returns void

isFunction

  • isFunction(val: any, msg?: string): void
  • Parameters

    • val: any
    • Optional msg: string

    Returns void

isNotArray

  • isNotArray(val: any, msg?: string): void
  • Parameters

    • val: any
    • Optional msg: string

    Returns void

isNotBoolean

  • isNotBoolean(val: any, msg?: string): void
  • Parameters

    • val: any
    • Optional msg: string

    Returns void

isNotFunction

  • isNotFunction(val: any, msg?: string): void
  • Parameters

    • val: any
    • Optional msg: string

    Returns void

isNotNull

  • isNotNull(val: any, msg?: string): void
  • Parameters

    • val: any
    • Optional msg: string

    Returns void

isNotNumber

  • isNotNumber(val: any, msg?: string): void
  • Parameters

    • val: any
    • Optional msg: string

    Returns void

isNotObject

  • isNotObject(val: any, msg?: string): void
  • Parameters

    • val: any
    • Optional msg: string

    Returns void

isNotString

  • isNotString(val: any, msg?: string): void
  • Parameters

    • val: any
    • Optional msg: string

    Returns void

isNull

  • isNull(val: any, msg?: string): void
  • Parameters

    • val: any
    • Optional msg: string

    Returns void

isNumber

  • isNumber(val: any, msg?: string): void
  • Parameters

    • val: any
    • Optional msg: string

    Returns void

isObject

  • isObject(val: any, msg?: string): void
  • Parameters

    • val: any
    • Optional msg: string

    Returns void

isString

  • isString(val: any, msg?: string): void
  • Parameters

    • val: any
    • Optional msg: string

    Returns void

isTrue

  • isTrue(val: any, msg?: string): void
  • Parameters

    • val: any
    • Optional msg: string

    Returns void

isUndefined

  • isUndefined(val: any, msg?: string): void
  • Parameters

    • val: any
    • Optional msg: string

    Returns void

lengthOf

  • lengthOf(exp: any, len: number, msg?: string): void
  • Parameters

    • exp: any
    • len: number
    • Optional msg: string

    Returns void

match

  • match(exp: any, re: RegExp, msg?: string): void
  • Parameters

    • exp: any
    • re: RegExp
    • Optional msg: string

    Returns void

notDeepEqual

  • notDeepEqual(act: any, exp: any, msg?: string): void
  • Parameters

    • act: any
    • exp: any
    • Optional msg: string

    Returns void

notDeepProperty

  • notDeepProperty(obj: Object, prop: string, msg?: string): void
  • Parameters

    • obj: Object
    • prop: string
    • Optional msg: string

    Returns void

notEqual

  • notEqual(act: any, exp: any, msg?: string): void
  • Parameters

    • act: any
    • exp: any
    • Optional msg: string

    Returns void

notInclude

  • notInclude(exp: string, inc: any, msg?: string): void
  • notInclude(exp: any[], inc: any, msg?: string): void
  • Parameters

    • exp: string
    • inc: any
    • Optional msg: string

    Returns void

  • Parameters

    • exp: any[]
    • inc: any
    • Optional msg: string

    Returns void

notInstanceOf

  • notInstanceOf(val: any, type: Function, msg?: string): void
  • Parameters

    • val: any
    • type: Function
    • Optional msg: string

    Returns void

notMatch

  • notMatch(exp: any, re: RegExp, msg?: string): void
  • Parameters

    • exp: any
    • re: RegExp
    • Optional msg: string

    Returns void

notOk

  • notOk(val: any, msg?: string): void
  • Parameters

    • val: any
    • Optional msg: string

    Returns void

notProperty

  • notProperty(obj: Object, prop: string, msg?: string): void
  • Parameters

    • obj: Object
    • prop: string
    • Optional msg: string

    Returns void

notStrictEqual

  • notStrictEqual(act: any, exp: any, msg?: string): void
  • Parameters

    • act: any
    • exp: any
    • Optional msg: string

    Returns void

notTypeOf

  • notTypeOf(val: any, type: string, msg?: string): void
  • Parameters

    • val: any
    • type: string
    • Optional msg: string

    Returns void

ok

  • ok(val: any, msg?: string): void
  • Parameters

    • val: any
    • Optional msg: string

    Returns void

operator

  • operator(val: any, operator: string, val2: any, msg?: string): void
  • Parameters

    • val: any
    • operator: string
    • val2: any
    • Optional msg: string

    Returns void

property

  • property(obj: Object, prop: string, msg?: string): void
  • Parameters

    • obj: Object
    • prop: string
    • Optional msg: string

    Returns void

propertyNotVal

  • propertyNotVal(obj: Object, prop: string, val: any, msg?: string): void
  • Parameters

    • obj: Object
    • prop: string
    • val: any
    • Optional msg: string

    Returns void

propertyVal

  • propertyVal(obj: Object, prop: string, val: any, msg?: string): void
  • Parameters

    • obj: Object
    • prop: string
    • val: any
    • Optional msg: string

    Returns void

sameMembers

  • sameMembers(set1: any[], set2: any[], msg?: string): void
  • Parameters

    • set1: any[]
    • set2: any[]
    • Optional msg: string

    Returns void

strictEqual

  • strictEqual(act: any, exp: any, msg?: string): void
  • Parameters

    • act: any
    • exp: any
    • Optional msg: string

    Returns void

throw

  • throw(fn: Function, msg?: string): void
  • throw(fn: Function, regExp: RegExp): void
  • throw(fn: Function, errType: Function, msg?: string): void
  • throw(fn: Function, errType: Function, regExp: RegExp): void
  • Parameters

    • fn: Function
    • Optional msg: string

    Returns void

  • Parameters

    • fn: Function
    • regExp: RegExp

    Returns void

  • Parameters

    • fn: Function
    • errType: Function
    • Optional msg: string

    Returns void

  • Parameters

    • fn: Function
    • errType: Function
    • regExp: RegExp

    Returns void

throws

  • throws(fn: Function, msg?: string): void
  • throws(fn: Function, regExp: RegExp): void
  • throws(fn: Function, errType: Function, msg?: string): void
  • throws(fn: Function, errType: Function, regExp: RegExp): void
  • Parameters

    • fn: Function
    • Optional msg: string

    Returns void

  • Parameters

    • fn: Function
    • regExp: RegExp

    Returns void

  • Parameters

    • fn: Function
    • errType: Function
    • Optional msg: string

    Returns void

  • Parameters

    • fn: Function
    • errType: Function
    • regExp: RegExp

    Returns void

typeOf

  • typeOf(val: any, type: string, msg?: string): void
  • Parameters

    • val: any
    • type: string
    • Optional msg: string

    Returns void

Assertion

  • __call(type: string, message?: string): Assertion
  • Parameters

    • type: string
    • Optional message: string

    Returns Assertion

Arguments

Arguments: Assertion

Throw

Throw: Throw

a

above

an

and

arguments

arguments: Assertion

at

be

been

been: Assertion

below

contain

contain: Include

deep

deep: Deep

empty

empty: Assertion

eq

eq: Equal

eql

eql: Equal

eqls

eqls: Equal

equal

equal: Equal

equals

equals: Equal

exist

exist: Assertion

false

false: Assertion

greaterThan

greaterThan: NumberComparer

gt

gte

has

have

have: Assertion

haveOwnProperty

haveOwnProperty: OwnProperty

include

include: Include

instanceOf

instanceOf: InstanceOf

instanceof

instanceof: InstanceOf

is

itself

itself: Assertion

keys

keys: Keys

least

length

length: Length

lengthOf

lengthOf: Length

lessThan

lessThan: NumberComparer

lt

lte

members

members: Members

most

not

null

null: Assertion

of

ok

ownProperty

ownProperty: OwnProperty

property

property: Property

same

same: Assertion

that

that: Assertion

throw

throw: Throw

throws

throws: Throw

to

true

true: Assertion

undefined

undefined: Assertion

which

which: Assertion

with

with: Assertion

closeTo

  • closeTo(expected: number, delta: number, message?: string): Assertion
  • Parameters

    • expected: number
    • delta: number
    • Optional message: string

    Returns Assertion

key

  • Parameters

    • string: string

    Returns Assertion

match

  • match(regexp: RegExp | string, message?: string): Assertion
  • Parameters

    • regexp: RegExp | string
    • Optional message: string

    Returns Assertion

respondTo

  • respondTo(method: string, message?: string): Assertion
  • Parameters

    • method: string
    • Optional message: string

    Returns Assertion

satisfy

  • satisfy(matcher: Function, message?: string): Assertion
  • Parameters

    • matcher: Function
    • Optional message: string

    Returns Assertion

string

  • string(string: string, message?: string): Assertion
  • Parameters

    • string: string
    • Optional message: string

    Returns Assertion

within

  • within(start: number, finish: number, message?: string): Assertion
  • Parameters

    • start: number
    • finish: number
    • Optional message: string

    Returns Assertion

AssertionStatic

  • __call(target: any, message?: string): Assertion
  • Parameters

    • target: any
    • Optional message: string

    Returns Assertion

ChaiStatic

ChaiStatic:

assert

assert: AssertStatic

config

config: Config

expect

expect: ExpectStatic

should

  • Returns Should

use

  • use(fn: function): any
  • Provides a way to extend the internals of Chai

    Parameters

    • fn: function
        • (chai: any, utils: any): void
        • Parameters

          • chai: any
          • utils: any

          Returns void

    Returns any

Config

Config:

includeStack

includeStack: boolean

Deep

Deep:

equal

equal: Equal

include

include: Include

property

property: Property

Equal

  • __call(value: any, message?: string): Assertion
  • Parameters

    • value: any
    • Optional message: string

    Returns Assertion

ExpectStatic

  • __call(target: any, message?: string): Assertion
  • Parameters

    • target: any
    • Optional message: string

    Returns Assertion

Include

  • __call(value: Object, message?: string): Assertion
  • __call(value: string, message?: string): Assertion
  • __call(value: number, message?: string): Assertion
  • Parameters

    • value: Object
    • Optional message: string

    Returns Assertion

  • Parameters

    • value: string
    • Optional message: string

    Returns Assertion

  • Parameters

    • value: number
    • Optional message: string

    Returns Assertion

keys

keys: Keys

members

members: Members

InstanceOf

  • __call(constructor: Object, message?: string): Assertion
  • Parameters

    • constructor: Object
    • Optional message: string

    Returns Assertion

Keys

  • Parameters

    • Rest ...keys: string[]

    Returns Assertion

  • Parameters

    • keys: any[]

    Returns Assertion

LanguageChains

LanguageChains:

and

at

be

been

been: Assertion

has

have

have: Assertion

is

of

same

same: Assertion

that

that: Assertion

to

which

which: Assertion

with

with: Assertion

Length

  • __call(length: number, message?: string): Assertion
  • Parameters

    • length: number
    • Optional message: string

    Returns Assertion

above

and

at

be

been

been: Assertion

below

greaterThan

greaterThan: NumberComparer

gt

gte

has

have

have: Assertion

is

least

lessThan

lessThan: NumberComparer

lt

lte

most

of

same

same: Assertion

that

that: Assertion

to

which

which: Assertion

with

with: Assertion

within

  • within(start: number, finish: number, message?: string): Assertion
  • Parameters

    • start: number
    • finish: number
    • Optional message: string

    Returns Assertion

Members

  • __call(set: any[], message?: string): Assertion
  • Parameters

    • set: any[]
    • Optional message: string

    Returns Assertion

NumberComparer

  • __call(value: number, message?: string): Assertion
  • Parameters

    • value: number
    • Optional message: string

    Returns Assertion

NumericComparison

NumericComparison:

above

below

greaterThan

greaterThan: NumberComparer

gt

gte

least

lessThan

lessThan: NumberComparer

lt

lte

most

within

  • within(start: number, finish: number, message?: string): Assertion
  • Parameters

    • start: number
    • finish: number
    • Optional message: string

    Returns Assertion

OwnProperty

  • __call(name: string, message?: string): Assertion
  • Parameters

    • name: string
    • Optional message: string

    Returns Assertion

Property

  • __call(name: string, value?: any, message?: string): Assertion
  • Parameters

    • name: string
    • Optional value: any
    • Optional message: string

    Returns Assertion

Should

Should:

Throw

not

throw

equal

  • equal(value1: any, value2: any, message?: string): void
  • Parameters

    • value1: any
    • value2: any
    • Optional message: string

    Returns void

exist

  • exist(value: any, message?: string): void
  • Parameters

    • value: any
    • Optional message: string

    Returns void

fail

  • fail(actual: any, expected: any, message?: string, operator?: string): void
  • Parameters

    • actual: any
    • expected: any
    • Optional message: string
    • Optional operator: string

    Returns void

ShouldAssertion

ShouldAssertion:

Throw

throw

equal

  • equal(value1: any, value2: any, message?: string): void
  • Parameters

    • value1: any
    • value2: any
    • Optional message: string

    Returns void

exist

  • exist(value: any, message?: string): void
  • Parameters

    • value: any
    • Optional message: string

    Returns void

ShouldThrow

  • __call(actual: Function): void
  • __call(actual: Function, expected: string | RegExp, message?: string): void
  • __call(actual: Function, constructor: Error | Function, expected?: string | RegExp, message?: string): void
  • Parameters

    • actual: Function

    Returns void

  • Parameters

    • actual: Function
    • expected: string | RegExp
    • Optional message: string

    Returns void

  • Parameters

    • actual: Function
    • constructor: Error | Function
    • Optional expected: string | RegExp
    • Optional message: string

    Returns void

Throw

  • __call(): Assertion
  • __call(expected: string, message?: string): Assertion
  • __call(expected: RegExp, message?: string): Assertion
  • __call(constructor: Error, expected?: string, message?: string): Assertion
  • __call(constructor: Error, expected?: RegExp, message?: string): Assertion
  • __call(constructor: Function, expected?: string, message?: string): Assertion
  • __call(constructor: Function, expected?: RegExp, message?: string): Assertion
  • Returns Assertion

  • Parameters

    • expected: string
    • Optional message: string

    Returns Assertion

  • Parameters

    • expected: RegExp
    • Optional message: string

    Returns Assertion

  • Parameters

    • constructor: Error
    • Optional expected: string
    • Optional message: string

    Returns Assertion

  • Parameters

    • constructor: Error
    • Optional expected: RegExp
    • Optional message: string

    Returns Assertion

  • Parameters

    • constructor: Function
    • Optional expected: string
    • Optional message: string

    Returns Assertion

  • Parameters

    • constructor: Function
    • Optional expected: RegExp
    • Optional message: string

    Returns Assertion

TypeComparison

  • __call(type: string, message?: string): Assertion
  • Parameters

    • type: string
    • Optional message: string

    Returns Assertion

instanceOf

instanceOf: InstanceOf

instanceof

instanceof: InstanceOf

Object

Object:

should

should: Assertion

chai

"typings/main/ambient/karma/index.d"

"typings/main/ambient/karma/index.d":

"karma"

"karma":

IKarma

IKarma:

runner

runner: IKarmaRunner

server

server: IKarmaServer

IKarmaRunner

IKarmaRunner:

run

  • run(options?: any, callback?: function): void
  • Parameters

    • Optional options: any
    • Optional callback: function
        • (exitCode: number): void
        • Parameters

          • exitCode: number

          Returns void

    Returns void

IKarmaServer

IKarmaServer:

start

  • start(options?: any, callback?: function): void
  • Parameters

    • Optional options: any
    • Optional callback: function
        • (exitCode: number): void
        • Parameters

          • exitCode: number

          Returns void

    Returns void

karma

karma: IKarma

"typings/main/ambient/lodash/index.d"

"typings/main/ambient/lodash/index.d":

"lodash"

"lodash":

_

DebounceSettings

DebounceSettings:

leading

leading: boolean

Specify execution on the leading edge of the timeout.

maxWait

maxWait: number

The maximum time func is allowed to be delayed before it's called.

trailing

trailing: boolean

Specify execution on the trailing edge of the timeout.

Dictionary

Dictionary:

DictionaryIterator

  • __call(value: T, key: string, collection: Dictionary<T>): TResult
  • Parameters

    Returns TResult

EqCustomizer

  • __call(value: any, other: any, indexOrKey?: number | string): boolean
  • Parameters

    • value: any
    • other: any
    • Optional indexOrKey: number | string

    Returns boolean

List

List:

length

length: number

ListIterator

  • __call(value: T, index: number, collection: T[]): TResult
  • Parameters

    • value: T
    • index: number
    • collection: T[]

    Returns TResult

LoDashArrayWrapper

LoDashArrayWrapper:

chain

  • Enables explicit method chaining on the wrapper object.

    see

    _.chain

    Returns LoDashArrayWrapper<T>

    The wrapper object.

chunk

  • see

    _.chunk

    Parameters

    • Optional size: number

    Returns LoDashArrayWrapper<T[]>

clone

  • clone(isDeep?: boolean, customizer?: function, thisArg?: any): T[]
  • clone(customizer?: function, thisArg?: any): T[]
  • see

    _.clone

    Parameters

    • Optional isDeep: boolean
    • Optional customizer: function
        • (value: any): any
        • Parameters

          • value: any

          Returns any

    • Optional thisArg: any

    Returns T[]

  • see

    _.clone

    Parameters

    • Optional customizer: function
        • (value: any): any
        • Parameters

          • value: any

          Returns any

    • Optional thisArg: any

    Returns T[]

cloneDeep

  • cloneDeep(customizer?: function, thisArg?: any): T[]
  • see

    _.cloneDeep

    Parameters

    • Optional customizer: function
        • (value: any): any
        • Parameters

          • value: any

          Returns any

    • Optional thisArg: any

    Returns T[]

collect

  • see

    _.map

    Type parameters

    • TResult

    Parameters

    Returns LoDashArrayWrapper<TResult>

  • see

    _.map

    Type parameters

    • TResult

    Parameters

    • pluckValue: string

    Returns LoDashArrayWrapper<TResult>

compact

  • see

    _.compact

    Returns LoDashArrayWrapper<T>

concat

  • Parameters

    • Rest ...items: Array<T | Array<T>>

    Returns LoDashArrayWrapper<T>

constant

  • constant<TResult>(): function
  • see

    _.constant

    Type parameters

    • TResult

    Returns function

      • (): TResult
      • Returns TResult

contains

  • contains(target: T, fromIndex?: number): boolean
  • see

    _.contains

    Parameters

    • target: T
    • Optional fromIndex: number

    Returns boolean

countBy

  • see

    _.countBy

    Parameters

    • Optional callback: ListIterator<T, any>
    • Optional thisArg: any

    Returns LoDashObjectWrapper<Dictionary<number>>

  • see

    _.countBy

    Parameters

    • callback: string

      Function name

    • Optional thisArg: any

    Returns LoDashObjectWrapper<Dictionary<number>>

difference

  • see

    _.difference

    Parameters

    • Rest ...others: Array<T>[]

    Returns LoDashArrayWrapper<T>

  • see

    _.difference

    Parameters

    • Rest ...others: List<T>[]

    Returns LoDashArrayWrapper<T>

each

  • see

    _.forEach

    Parameters

    Returns LoDashArrayWrapper<T>

eachRight

  • see

    _.forEachRight

    Parameters

    Returns LoDashArrayWrapper<T>

eq

  • eq(other?: any, callback?: EqCustomizer, thisArg?: any): boolean
  • see

    _.isEqual

    Parameters

    • Optional other: any
    • Optional callback: EqCustomizer
    • Optional thisArg: any

    Returns boolean

fill

  • fill<TResult>(value: TResult, start?: number, end?: number): LoDashArrayWrapper<TResult>
  • see

    _.fill

    Type parameters

    • TResult

    Parameters

    • value: TResult
    • Optional start: number
    • Optional end: number

    Returns LoDashArrayWrapper<TResult>

filter

  • see

    _.filter

    Returns LoDashArrayWrapper<T>

  • see

    _.filter

    Parameters

    Returns LoDashArrayWrapper<T>

  • see

    _.filter

    Parameters

    • pluckValue: string

      _.pluck style callback

    Returns LoDashArrayWrapper<T>

  • see

    _.filter

    Type parameters

    • W

    Parameters

    • whereValue: W

    Returns LoDashArrayWrapper<T>

find

  • find(callback: ListIterator<T, boolean>, thisArg?: any): T
  • find<W>(whereValue: W): T
  • find(path: string, srcValue: any): T
  • find(pluckValue: string): T
  • see

    _.find

    Parameters

    Returns T

  • see

    _.find

    Type parameters

    • W

    Parameters

    • whereValue: W

    Returns T

  • see

    _.find

    Parameters

    • path: string
    • srcValue: any

    Returns T

  • see

    _.find

    Parameters

    • pluckValue: string

    Returns T

findLast

  • findLast(callback: ListIterator<T, boolean>, thisArg?: any): T
  • findLast<W>(whereValue: W): T
  • findLast(pluckValue: string): T
  • see

    _.findLast

    Parameters

    Returns T

  • see

    _.findLast

    Type parameters

    • W

    Parameters

    • whereValue: W

    Returns T

  • see

    _.findLast

    Parameters

    • pluckValue: string

    Returns T

first

  • see

    _.first

    Returns T

  • see

    _.first

    Parameters

    • n: number

      The number of elements to return.

    Returns LoDashArrayWrapper<T>

  • see

    _.first

    Parameters

    • callback: ListIterator<T, boolean>

      The function called per element.

    • Optional thisArg: any

    Returns LoDashArrayWrapper<T>

  • see

    _.first

    Parameters

    • pluckValue: string

      "_.pluck" style callback value

    Returns LoDashArrayWrapper<T>

  • see

    _.first

    Type parameters

    • W

    Parameters

    • whereValue: W

      "_.where" style callback value

    Returns LoDashArrayWrapper<T>

flatten

  • see

    _.flatten

    Type parameters

    • T

    Returns LoDashArrayWrapper<any>

  • see

    _.flatten

    Type parameters

    • T

    Parameters

    • isShallow: boolean

    Returns LoDashArrayWrapper<any>

flattenDeep

  • see

    _.flattenDeep

    Type parameters

    • T

    Returns LoDashArrayWrapper<any>

foldl

  • foldl<TResult>(callback: MemoIterator<T, TResult>, accumulator: TResult, thisArg?: any): TResult
  • foldl<TResult>(callback: MemoIterator<T, TResult>, thisArg?: any): TResult
  • see

    _.reduce

    Type parameters

    • TResult

    Parameters

    • callback: MemoIterator<T, TResult>
    • accumulator: TResult
    • Optional thisArg: any

    Returns TResult

  • see

    _.reduce

    Type parameters

    • TResult

    Parameters

    Returns TResult

forEach

  • see

    _.forEach

    Parameters

    Returns LoDashArrayWrapper<T>

forEachRight

  • see

    _.forEachRight

    Parameters

    Returns LoDashArrayWrapper<T>

groupBy

gt

  • gt(other: any): boolean
  • see

    _.gt

    Parameters

    • other: any

    Returns boolean

gte

  • gte(other: any): boolean
  • see

    _.gte

    Parameters

    • other: any

    Returns boolean

head

  • see

    _.first

    Returns T

  • see

    _.first

    Parameters

    • n: number

      The number of elements to return.

    Returns LoDashArrayWrapper<T>

  • see

    _.first

    Parameters

    • callback: ListIterator<T, boolean>

      The function called per element.

    • Optional thisArg: any

    Returns LoDashArrayWrapper<T>

  • see

    _.first

    Parameters

    • pluckValue: string

      "_.pluck" style callback value

    Returns LoDashArrayWrapper<T>

  • see

    _.first

    Type parameters

    • W

    Parameters

    • whereValue: W

      "_.where" style callback value

    Returns LoDashArrayWrapper<T>

identity

  • identity(): T[]
  • see

    _.identity

    Returns T[]

include

  • include(target: T, fromIndex?: number): boolean
  • see

    _.contains

    Parameters

    • target: T
    • Optional fromIndex: number

    Returns boolean

includes

  • includes(target: T, fromIndex?: number): boolean
  • see

    _.contains

    Parameters

    • target: T
    • Optional fromIndex: number

    Returns boolean

inject

  • inject<TResult>(callback: MemoIterator<T, TResult>, accumulator: TResult, thisArg?: any): TResult
  • inject<TResult>(callback: MemoIterator<T, TResult>, thisArg?: any): TResult
  • see

    _.reduce

    Type parameters

    • TResult

    Parameters

    • callback: MemoIterator<T, TResult>
    • accumulator: TResult
    • Optional thisArg: any

    Returns TResult

  • see

    _.reduce

    Type parameters

    • TResult

    Parameters

    Returns TResult

isArguments

  • isArguments(): boolean

isArray

  • isArray(): boolean
  • see

    _.isArray

    Returns boolean

isBoolean

  • isBoolean(): boolean
  • see

    _.isBoolean

    Returns boolean

isDate

  • isDate(): boolean
  • see

    _.isDate

    Returns boolean

isElement

  • isElement(): boolean
  • see

    _.isElement

    Returns boolean

isEmpty

  • isEmpty(): boolean
  • see

    _.isEmpty

    Returns boolean

isEqual

  • isEqual(other?: any, callback?: EqCustomizer, thisArg?: any): boolean
  • see

    _.isEqual

    Parameters

    • Optional other: any
    • Optional callback: EqCustomizer
    • Optional thisArg: any

    Returns boolean

isError

  • isError(): boolean
  • see

    _.isError

    Returns boolean

isFinite

  • isFinite(): boolean
  • see

    _.isFinite

    Returns boolean

isFunction

  • isFunction(): boolean

isNaN

  • isNaN(): boolean
  • see

    _.isNaN

    Returns boolean

isNative

  • isNative(): boolean
  • see _.isNative

    Returns boolean

isNull

  • isNull(): boolean
  • see _.isNull

    Returns boolean

isNumber

  • isNumber(): boolean
  • see _.isNumber

    Returns boolean

isObject

  • isObject(): boolean
  • see _.isObject

    Returns boolean

isPlainObject

  • isPlainObject(): boolean

isRegExp

  • isRegExp(): boolean
  • see _.isRegExp

    Returns boolean

isString

  • isString(): boolean
  • see _.isString

    Returns boolean

isTypedArray

  • isTypedArray(): boolean

isUndefined

  • isUndefined(): boolean

join

  • join(seperator?: string): string
  • Parameters

    • Optional seperator: string

    Returns string

last

  • last(): T
  • see

    _.last

    Returns T

lt

  • lt(other: any): boolean
  • see

    _.lt

    Parameters

    • other: any

    Returns boolean

lte

  • lte(other: any): boolean
  • see

    _.lte

    Parameters

    • other: any

    Returns boolean

map

  • see

    _.map

    Type parameters

    • TResult

    Parameters

    Returns LoDashArrayWrapper<TResult>

  • see

    _.map

    Type parameters

    • TResult

    Parameters

    • pluckValue: string

      _.pluck style callback

    Returns LoDashArrayWrapper<TResult>

max

  • see

    _.max

    Parameters

    • Optional callback: ListIterator<T, any>
    • Optional thisArg: any

    Returns LoDashWrapper<T>

  • see

    _.max

    Parameters

    • pluckValue: string

      _.pluck style callback

    Returns LoDashWrapper<T>

  • see

    _.max

    Type parameters

    • W

    Parameters

    • whereValue: W

      _.where style callback

    Returns LoDashWrapper<T>

method

  • see

    _.method

    Type parameters

    • TResult

    Parameters

    • Rest ...args: any[]

    Returns LoDashWrapper<function>

  • see

    _.method

    Type parameters

    • TResult

    Parameters

    • Rest ...args: any[]

    Returns LoDashWrapper<function>

min

  • see

    _.min

    Parameters

    • Optional callback: ListIterator<T, any>
    • Optional thisArg: any

    Returns LoDashWrapper<T>

  • see

    _.min

    Parameters

    • pluckValue: string

      _.pluck style callback

    Returns LoDashWrapper<T>

  • see

    _.min

    Type parameters

    • W

    Parameters

    • whereValue: W

      _.where style callback

    Returns LoDashWrapper<T>

noop

  • noop(...args: any[]): void
  • see

    _.noop

    Parameters

    • Rest ...args: any[]

    Returns void

object

partition

  • see

    _.partition

    Parameters

    Returns LoDashArrayWrapper<T[]>

  • see

    _.partition

    Type parameters

    • W

    Parameters

    • whereValue: W

    Returns LoDashArrayWrapper<T[]>

  • see

    _.partition

    Parameters

    • path: string
    • srcValue: any

    Returns LoDashArrayWrapper<T[]>

  • see

    _.partition

    Parameters

    • pluckValue: string

    Returns LoDashArrayWrapper<T[]>

pluck

  • see

    _.pluck

    Type parameters

    • TResult

    Parameters

    • property: string

    Returns LoDashArrayWrapper<TResult>

pop

  • pop(): T
  • Returns T

property

  • see

    _.property

    Type parameters

    • TObj

    • TResult

    Returns LoDashObjectWrapper<function>

push

  • Parameters

    • Rest ...items: T[]

    Returns LoDashArrayWrapper<T>

reduce

  • reduce<TResult>(callback: MemoIterator<T, TResult>, accumulator: TResult, thisArg?: any): TResult
  • reduce<TResult>(callback: MemoIterator<T, TResult>, thisArg?: any): TResult
  • see

    _.reduce

    Type parameters

    • TResult

    Parameters

    • callback: MemoIterator<T, TResult>
    • accumulator: TResult
    • Optional thisArg: any

    Returns TResult

  • see

    _.reduce

    Type parameters

    • TResult

    Parameters

    Returns TResult

reject

  • see

    _.reject

    Parameters

    Returns LoDashArrayWrapper<T>

  • see

    _.reject

    Parameters

    • pluckValue: string

      _.pluck style callback

    Returns LoDashArrayWrapper<T>

  • see

    _.reject

    Type parameters

    • W

    Parameters

    • whereValue: W

      _.where style callback

    Returns LoDashArrayWrapper<T>

reverse

run

  • run(): T[]
  • see

    _.value

    Returns T[]

sample

  • see

    _.sample

    Parameters

    • n: number

    Returns LoDashArrayWrapper<T>

  • see

    _.sample

    Returns LoDashWrapper<T>

select

  • see

    _.filter

    Parameters

    Returns LoDashArrayWrapper<T>

  • see

    _.filter

    Parameters

    • pluckValue: string

      _.pluck style callback

    Returns LoDashArrayWrapper<T>

  • see

    _.filter

    Type parameters

    • W

    Parameters

    • whereValue: W

    Returns LoDashArrayWrapper<T>

shift

  • shift(): T
  • Returns T

shuffle

  • see

    _.shuffle

    Returns LoDashArrayWrapper<T>

size

  • size(): number
  • see

    _.size

    Returns number

slice

  • Parameters

    • start: number
    • Optional end: number

    Returns LoDashArrayWrapper<T>

sort

  • Parameters

    • Optional compareFn: function
        • (a: T, b: T): number
        • Parameters

          • a: T
          • b: T

          Returns number

    Returns LoDashArrayWrapper<T>

sortBy

  • see

    _.sortBy

    Type parameters

    • TSort

    Parameters

    • Optional iteratee: ListIterator<T, TSort>
    • Optional thisArg: any

    Returns LoDashArrayWrapper<T>

  • see

    _.sortBy

    Parameters

    • pluckValue: string

      _.pluck style callback

    Returns LoDashArrayWrapper<T>

  • see

    _.sortBy

    Type parameters

    • W

    Parameters

    • whereValue: W

      _.where style callback

    Returns LoDashArrayWrapper<T>

sortByAll

  • Sorts by all the given arguments, using either ListIterator, pluckValue, or whereValue foramts

    Parameters

    • Rest ...args: ListIterator<T, boolean> | Object | string

      The rules by which to sort

    Returns LoDashArrayWrapper<T>

  • see

    _.sortByAll

    Parameters

    Returns LoDashArrayWrapper<T>

  • see

    _.sortByAll

    Parameters

    Returns LoDashArrayWrapper<T>

sortByOrder

  • see

    _.sortByOrder

    Parameters

    • iteratees: ListIterator<T, any> | string | Object
    • Optional orders: boolean[]

    Returns LoDashArrayWrapper<T>

  • see

    _.sortByOrder

    Parameters

    • iteratees: ListIterator<T, any> | string | Object
    • Optional orders: string[]

    Returns LoDashArrayWrapper<T>

splice

  • Parameters

    • start: number

    Returns LoDashArrayWrapper<T>

  • Parameters

    • start: number
    • deleteCount: number
    • Rest ...items: any[]

    Returns LoDashArrayWrapper<T>

sum

  • sum(): number
  • sum(iteratee: ListIterator<T, number>, thisArg?: any): number
  • sum(property: string): number
  • see

    _.sum

    Returns number

  • see

    _.sum

    Parameters

    Returns number

  • see

    _.sum

    Parameters

    • property: string

      _.property callback shorthand.

    Returns number

take

  • see

    _.first

    Returns LoDashArrayWrapper<T>

  • see

    _.first

    Parameters

    • n: number

      The number of elements to return.

    Returns LoDashArrayWrapper<T>

takeWhile

  • Takes the first items based on a predicate

    Parameters

    • predicate: ListIterator<T, boolean>

      The function called per element.

    • Optional thisArg: any

    Returns LoDashArrayWrapper<T>

  • Takes the first items based on a predicate

    Type parameters

    • T

    Parameters

    • pluckValue: string

      Uses a _.property style callback to return the property value of the given element

    Returns LoDashArrayWrapper<any>

  • Takes the first items based on a predicate

    Type parameters

    • W

    • T

    Parameters

    • whereValue: W

      Uses a _.matches style callback to return the first elements that match the given value

    Returns LoDashArrayWrapper<T>

tap

  • see

    _.tap

    Parameters

    • interceptor: function
        • (value: T[]): void
        • Parameters

          • value: T[]

          Returns void

    Returns LoDashArrayWrapper<T>

toArray

  • see

    _.toArray

    Returns LoDashArrayWrapper<T>

toJSON

  • toJSON(): T[]
  • see

    _.value

    Returns T[]

toPlainObject

  • toPlainObject(): Object

toString

  • toString(): string
  • Produces the toString result of the wrapped value.

    Returns string

    Returns the string result.

union

  • see

    _.union

    Type parameters

    • T

    Parameters

    • Rest ...arrays: Array<T> | List<T>

    Returns LoDashArrayWrapper<T>

uniq

  • see

    _.uniq

    Type parameters

    • TSort

    Parameters

    • Optional isSorted: boolean

    Returns LoDashArrayWrapper<T>

  • see

    _.uniq

    Type parameters

    • TSort

    Parameters

    • isSorted: boolean
    • callback: ListIterator<T, TSort>
    • Optional thisArg: any

    Returns LoDashArrayWrapper<T>

  • see

    _.uniq

    Type parameters

    • TSort

    Parameters

    Returns LoDashArrayWrapper<T>

  • see

    _.uniq

    Parameters

    • isSorted: boolean
    • pluckValue: string

      _.pluck style callback

    Returns LoDashArrayWrapper<T>

  • see

    _.uniq

    Parameters

    • pluckValue: string

      _.pluck style callback

    Returns LoDashArrayWrapper<T>

  • see

    _.uniq

    Type parameters

    • W

    Parameters

    • isSorted: boolean
    • whereValue: W

      _.where style callback

    Returns LoDashArrayWrapper<T>

  • see

    _.uniq

    Type parameters

    • W

    Parameters

    • whereValue: W

      _.where style callback

    Returns LoDashArrayWrapper<T>

unique

  • see

    _.uniq

    Type parameters

    • TSort

    Parameters

    • Optional isSorted: boolean

    Returns LoDashArrayWrapper<T>

  • see

    _.uniq

    Type parameters

    • TSort

    Parameters

    • isSorted: boolean
    • callback: ListIterator<T, TSort>
    • Optional thisArg: any

    Returns LoDashArrayWrapper<T>

  • see

    _.uniq

    Type parameters

    • TSort

    Parameters

    Returns LoDashArrayWrapper<T>

  • see

    _.uniq

    Parameters

    • isSorted: boolean
    • pluckValue: string

      _.pluck style callback

    Returns LoDashArrayWrapper<T>

  • see

    _.uniq

    Parameters

    • pluckValue: string

      _.pluck style callback

    Returns LoDashArrayWrapper<T>

  • see

    _.uniq

    Type parameters

    • W

    Parameters

    • isSorted: boolean
    • whereValue: W

      _.where style callback

    Returns LoDashArrayWrapper<T>

  • see

    _.uniq

    Type parameters

    • W

    Parameters

    • whereValue: W

      _.where style callback

    Returns LoDashArrayWrapper<T>

unshift

  • Parameters

    • Rest ...items: T[]

    Returns LoDashArrayWrapper<T>

unzip

  • see

    _.zip

    Parameters

    • Rest ...arrays: any[]

    Returns LoDashArrayWrapper<any[]>

value

  • value(): T[]
  • Executes the chained sequence to extract the unwrapped value.

    Returns T[]

    Returns the resolved unwrapped value.

valueOf

  • valueOf(): T[]
  • see

    _.value

    Returns T[]

where

  • see

    _.where

    Type parameters

    • U: object

    Parameters

    • properties: U

    Returns LoDashArrayWrapper<T>

xor

  • see

    _.xor

    Parameters

    • Rest ...arrays: T[]

    Returns LoDashArrayWrapper<T>

zip

  • see

    _.zip

    Parameters

    • Rest ...arrays: any[]

    Returns LoDashArrayWrapper<any[]>

zipObject

zipWith

  • see

    _.zipWith

    Type parameters

    • TResult

    Parameters

    • Rest ...args: any[]

    Returns LoDashArrayWrapper<TResult>

LoDashNumberArrayWrapper

LoDashNumberArrayWrapper:

chunk

clone

  • clone(isDeep?: boolean, customizer?: function, thisArg?: any): number[]
  • clone(customizer?: function, thisArg?: any): number[]
  • see

    _.clone

    Parameters

    • Optional isDeep: boolean
    • Optional customizer: function
        • (value: any): any
        • Parameters

          • value: any

          Returns any

    • Optional thisArg: any

    Returns number[]

  • see

    _.clone

    Parameters

    • Optional customizer: function
        • (value: any): any
        • Parameters

          • value: any

          Returns any

    • Optional thisArg: any

    Returns number[]

cloneDeep

  • cloneDeep(customizer?: function, thisArg?: any): number[]
  • see

    _.cloneDeep

    Parameters

    • Optional customizer: function
        • (value: any): any
        • Parameters

          • value: any

          Returns any

    • Optional thisArg: any

    Returns number[]

collect

compact

concat

contains

  • contains(target: number, fromIndex?: number): boolean
  • see

    _.contains

    Parameters

    • target: number
    • Optional fromIndex: number

    Returns boolean

countBy

difference

each

eachRight

eq

  • eq(other?: any, callback?: EqCustomizer, thisArg?: any): boolean
  • see

    _.isEqual

    Parameters

    • Optional other: any
    • Optional callback: EqCustomizer
    • Optional thisArg: any

    Returns boolean

fill

  • fill<TResult>(value: TResult, start?: number, end?: number): LoDashArrayWrapper<TResult>
  • see

    _.fill

    Type parameters

    • TResult

    Parameters

    • value: TResult
    • Optional start: number
    • Optional end: number

    Returns LoDashArrayWrapper<TResult>

filter

find

  • find(callback: ListIterator<number, boolean>, thisArg?: any): number
  • find<W>(whereValue: W): number
  • find(path: string, srcValue: any): number
  • find(pluckValue: string): number
  • see

    _.find

    Parameters

    • callback: ListIterator<number, boolean>
    • Optional thisArg: any

    Returns number

  • see

    _.find

    Type parameters

    • W

    Parameters

    • whereValue: W

    Returns number

  • see

    _.find

    Parameters

    • path: string
    • srcValue: any

    Returns number

  • see

    _.find

    Parameters

    • pluckValue: string

    Returns number

findLast

  • findLast(callback: ListIterator<number, boolean>, thisArg?: any): number
  • findLast<W>(whereValue: W): number
  • findLast(pluckValue: string): number
  • see

    _.findLast

    Parameters

    • callback: ListIterator<number, boolean>
    • Optional thisArg: any

    Returns number

  • see

    _.findLast

    Type parameters

    • W

    Parameters

    • whereValue: W

    Returns number

  • see

    _.findLast

    Parameters

    • pluckValue: string

    Returns number

first

flatten

flattenDeep

foldl

  • foldl<TResult>(callback: MemoIterator<number, TResult>, accumulator: TResult, thisArg?: any): TResult
  • foldl<TResult>(callback: MemoIterator<number, TResult>, thisArg?: any): TResult
  • see

    _.reduce

    Type parameters

    • TResult

    Parameters

    • callback: MemoIterator<number, TResult>
    • accumulator: TResult
    • Optional thisArg: any

    Returns TResult

  • see

    _.reduce

    Type parameters

    • TResult

    Parameters

    • callback: MemoIterator<number, TResult>
    • Optional thisArg: any

    Returns TResult

forEach

forEachRight

groupBy

head

  • see

    _.first

    Returns number

  • see

    _.first

    Parameters

    • n: number

      The number of elements to return.

    Returns LoDashArrayWrapper<number>

  • see

    _.first

    Parameters

    • callback: ListIterator<number, boolean>

      The function called per element.

    • Optional thisArg: any

    Returns LoDashArrayWrapper<number>

  • see

    _.first

    Parameters

    • pluckValue: string

      "_.pluck" style callback value

    Returns LoDashArrayWrapper<number>

  • see

    _.first

    Type parameters

    • W

    Parameters

    • whereValue: W

      "_.where" style callback value

    Returns LoDashArrayWrapper<number>

identity

  • identity(): number[]
  • see

    _.identity

    Returns number[]

include

  • include(target: number, fromIndex?: number): boolean
  • see

    _.contains

    Parameters

    • target: number
    • Optional fromIndex: number

    Returns boolean

includes

  • includes(target: number, fromIndex?: number): boolean
  • see

    _.contains

    Parameters

    • target: number
    • Optional fromIndex: number

    Returns boolean

inject

  • inject<TResult>(callback: MemoIterator<number, TResult>, accumulator: TResult, thisArg?: any): TResult
  • inject<TResult>(callback: MemoIterator<number, TResult>, thisArg?: any): TResult
  • see

    _.reduce

    Type parameters

    • TResult

    Parameters

    • callback: MemoIterator<number, TResult>
    • accumulator: TResult
    • Optional thisArg: any

    Returns TResult

  • see

    _.reduce

    Type parameters

    • TResult

    Parameters

    • callback: MemoIterator<number, TResult>
    • Optional thisArg: any

    Returns TResult

isEqual

  • isEqual(other?: any, callback?: EqCustomizer, thisArg?: any): boolean
  • see

    _.isEqual

    Parameters

    • Optional other: any
    • Optional callback: EqCustomizer
    • Optional thisArg: any

    Returns boolean

join

  • join(seperator?: string): string
  • Parameters

    • Optional seperator: string

    Returns string

last

  • last(): number
  • see

    _.last

    Returns number

map

  • see

    _.map

    Type parameters

    • TResult

    Parameters

    • callback: ListIterator<number, TResult>
    • Optional thisArg: any

    Returns LoDashArrayWrapper<TResult>

  • see

    _.map

    Type parameters

    • TResult

    Parameters

    • pluckValue: string

      _.pluck style callback

    Returns LoDashArrayWrapper<TResult>

max

  • see

    _.max

    Parameters

    • Optional callback: ListIterator<number, any>
    • Optional thisArg: any

    Returns LoDashWrapper<number>

  • see

    _.max

    Parameters

    • pluckValue: string

      _.pluck style callback

    Returns LoDashWrapper<number>

  • see

    _.max

    Type parameters

    • W

    Parameters

    • whereValue: W

      _.where style callback

    Returns LoDashWrapper<number>

method

  • see

    _.method

    Type parameters

    • TResult

    Parameters

    • Rest ...args: any[]

    Returns LoDashWrapper<function>

  • see

    _.method

    Type parameters

    • TResult

    Parameters

    • Rest ...args: any[]

    Returns LoDashWrapper<function>

min

  • see

    _.min

    Parameters

    • Optional callback: ListIterator<number, any>
    • Optional thisArg: any

    Returns LoDashWrapper<number>

  • see

    _.min

    Parameters

    • pluckValue: string

      _.pluck style callback

    Returns LoDashWrapper<number>

  • see

    _.min

    Type parameters

    • W

    Parameters

    • whereValue: W

      _.where style callback

    Returns LoDashWrapper<number>

object

partition

pluck

pop

  • pop(): number
  • Returns number

property

push

reduce

  • reduce<TResult>(callback: MemoIterator<number, TResult>, accumulator: TResult, thisArg?: any): TResult
  • reduce<TResult>(callback: MemoIterator<number, TResult>, thisArg?: any): TResult
  • see

    _.reduce

    Type parameters

    • TResult

    Parameters

    • callback: MemoIterator<number, TResult>
    • accumulator: TResult
    • Optional thisArg: any

    Returns TResult

  • see

    _.reduce

    Type parameters

    • TResult

    Parameters

    • callback: MemoIterator<number, TResult>
    • Optional thisArg: any

    Returns TResult

reject

reverse

run

  • run(): number[]
  • see

    _.value

    Returns number[]

sample

select

shift

  • shift(): number

shuffle

size

  • size(): number
  • see

    _.size

    Returns number

slice

sort

  • Parameters

    • Optional compareFn: function
        • (a: number, b: number): number
        • Parameters

          • a: number
          • b: number

          Returns number

    Returns LoDashArrayWrapper<number>

sortBy

sortByAll

sortByOrder

splice

sum

  • sum(): number
  • sum(iteratee: ListIterator<number, number>, thisArg?: any): number
  • sum(property: string): number
  • sum(): number
  • sum(iteratee: ListIterator<number, number>, thisArg?: any): number
  • see

    _.sum

    Returns number

  • see

    _.sum

    Parameters

    • iteratee: ListIterator<number, number>
    • Optional thisArg: any

    Returns number

  • see

    _.sum

    Parameters

    • property: string

      _.property callback shorthand.

    Returns number

  • see

    _.sum

    Returns number

  • see

    _.sum

    Parameters

    • iteratee: ListIterator<number, number>
    • Optional thisArg: any

    Returns number

take

takeWhile

  • Takes the first items based on a predicate

    Parameters

    • predicate: ListIterator<number, boolean>

      The function called per element.

    • Optional thisArg: any

    Returns LoDashArrayWrapper<number>

  • Takes the first items based on a predicate

    Type parameters

    • T

    Parameters

    • pluckValue: string

      Uses a _.property style callback to return the property value of the given element

    Returns LoDashArrayWrapper<any>

  • Takes the first items based on a predicate

    Type parameters

    • W

    • T

    Parameters

    • whereValue: W

      Uses a _.matches style callback to return the first elements that match the given value

    Returns LoDashArrayWrapper<T>

toArray

toJSON

  • toJSON(): number[]
  • see

    _.value

    Returns number[]

toPlainObject

  • toPlainObject(): Object

toString

  • toString(): string
  • Produces the toString result of the wrapped value.

    Returns string

    Returns the string result.

union

uniq

unique

unshift

unzip

value

  • value(): number[]
  • Executes the chained sequence to extract the unwrapped value.

    Returns number[]

    Returns the resolved unwrapped value.

valueOf

  • valueOf(): number[]
  • see

    _.value

    Returns number[]

where

xor

zip

zipObject

zipWith

LoDashObjectWrapper

LoDashObjectWrapper:

ary

  • see

    _.ary

    Type parameters

    • TResult: Function

    Parameters

    • Optional n: number
    • Optional guard: Object

    Returns LoDashObjectWrapper<TResult>

assign

  • assign<S1, Value, TResult>(s1: S1, callback?: function, thisArg?: any): TResult
  • assign<S1, S2, Value, TResult>(s1: S1, s2: S2, callback?: function, thisArg?: any): TResult
  • assign<S1, S2, S3, Value, TResult>(s1: S1, s2: S2, s3: S3, callback?: function, thisArg?: any): TResult
  • assign<S1, S2, S3, S4, Value, TResult>(s1: S1, s2: S2, s3: S3, s4: S4, callback?: function, thisArg?: any): TResult
  • assign<S1, S2, S3, S4, S5, Value, TResult>(s1: S1, s2: S2, s3: S3, s4: S4, s5: S5, callback?: function, thisArg?: any): TResult
  • see

    _.assign

    Type parameters

    • S1

    • Value

    • TResult

    Parameters

    • s1: S1
    • Optional callback: function
        • (objectValue: Value, sourceValue: Value): Value
        • Parameters

          • objectValue: Value
          • sourceValue: Value

          Returns Value

    • Optional thisArg: any

    Returns TResult

  • see

    _.assign

    Type parameters

    • S1

    • S2

    • Value

    • TResult

    Parameters

    • s1: S1
    • s2: S2
    • Optional callback: function
        • (objectValue: Value, sourceValue: Value): Value
        • Parameters

          • objectValue: Value
          • sourceValue: Value

          Returns Value

    • Optional thisArg: any

    Returns TResult

  • see

    _.assign

    Type parameters

    • S1

    • S2

    • S3

    • Value

    • TResult

    Parameters

    • s1: S1
    • s2: S2
    • s3: S3
    • Optional callback: function
        • (objectValue: Value, sourceValue: Value): Value
        • Parameters

          • objectValue: Value
          • sourceValue: Value

          Returns Value

    • Optional thisArg: any

    Returns TResult

  • see

    _.assign

    Type parameters

    • S1

    • S2

    • S3

    • S4

    • Value

    • TResult

    Parameters

    • s1: S1
    • s2: S2
    • s3: S3
    • s4: S4
    • Optional callback: function
        • (objectValue: Value, sourceValue: Value): Value
        • Parameters

          • objectValue: Value
          • sourceValue: Value

          Returns Value

    • Optional thisArg: any

    Returns TResult

  • see

    _.assign

    Type parameters

    • S1

    • S2

    • S3

    • S4

    • S5

    • Value

    • TResult

    Parameters

    • s1: S1
    • s2: S2
    • s3: S3
    • s4: S4
    • s5: S5
    • Optional callback: function
        • (objectValue: Value, sourceValue: Value): Value
        • Parameters

          • objectValue: Value
          • sourceValue: Value

          Returns Value

    • Optional thisArg: any

    Returns TResult

attempt

  • attempt<TResult>(): TResult | Error
  • see

    _.attempt

    Type parameters

    • TResult

    Returns TResult | Error

backflow

  • see

    _.flowRight

    Type parameters

    • TResult: Function

    Parameters

    • Rest ...funcs: Function[]

    Returns LoDashObjectWrapper<TResult>

bind

  • see

    _.bind

    Parameters

    • thisArg: any
    • Rest ...args: any[]

    Returns LoDashObjectWrapper<function>

bindAll

  • see

    _.bindAll

    Parameters

    • Rest ...methodNames: string[]

    Returns LoDashWrapper<T>

bindKey

  • see

    _.bindKey

    Parameters

    • key: string
    • Rest ...args: any[]

    Returns LoDashObjectWrapper<Function>

chain

  • Enables explicit method chaining on the wrapper object.

    see

    _.chain

    Returns LoDashObjectWrapper<T>

    The wrapper object.

clone

  • clone(isDeep?: boolean, customizer?: function, thisArg?: any): T
  • clone(customizer?: function, thisArg?: any): T
  • see

    _.clone

    Parameters

    • Optional isDeep: boolean
    • Optional customizer: function
        • (value: any): any
        • Parameters

          • value: any

          Returns any

    • Optional thisArg: any

    Returns T

  • see

    _.clone

    Parameters

    • Optional customizer: function
        • (value: any): any
        • Parameters

          • value: any

          Returns any

    • Optional thisArg: any

    Returns T

cloneDeep

  • cloneDeep(customizer?: function, thisArg?: any): T
  • see

    _.cloneDeep

    Parameters

    • Optional customizer: function
        • (value: any): any
        • Parameters

          • value: any

          Returns any

    • Optional thisArg: any

    Returns T

collect

  • see

    _.map

    Type parameters

    • T: object

    • TResult

    Parameters

    Returns LoDashArrayWrapper<TResult>

compose

  • see

    _.flowRight

    Type parameters

    • TResult: Function

    Parameters

    • Rest ...funcs: Function[]

    Returns LoDashObjectWrapper<TResult>

constant

  • constant<TResult>(): function
  • see

    _.constant

    Type parameters

    • TResult

    Returns function

      • (): TResult
      • Returns TResult

contains

  • contains<TValue>(target: TValue, fromIndex?: number): boolean
  • see

    _.contains

    Type parameters

    • TValue

    Parameters

    • target: TValue
    • Optional fromIndex: number

    Returns boolean

create

  • see

    _.create

    Type parameters

    • TResult: object

    Parameters

    • Optional properties: Object

    Returns LoDashObjectWrapper<TResult>

createCallback

  • see

    _.createCallback

    Parameters

    • Optional thisArg: any
    • Optional argCount: number

    Returns LoDashObjectWrapper<function>

curry

  • see

    _.curry

    Type parameters

    • TResult: Function

    Parameters

    • Optional arity: number

    Returns LoDashObjectWrapper<TResult>

curryRight

  • see

    _.curryRight

    Type parameters

    • TResult: Function

    Parameters

    • Optional arity: number

    Returns LoDashObjectWrapper<TResult>

debounce

defaults

  • see

    _.defaults

    Type parameters

    • T

    • TResult

    Parameters

    • Rest ...sources: any[]

    Returns LoDashObjectWrapper<TResult>

defaultsDeep

  • see

    _.defaultsDeep

    Type parameters

    • TResult

    Parameters

    • Rest ...sources: any[]

    Returns LoDashObjectWrapper<TResult>

defer

  • see

    _.defer

    Parameters

    • Rest ...args: any[]

    Returns LoDashWrapper<number>

delay

  • see

    _.delay

    Parameters

    • wait: number
    • Rest ...args: any[]

    Returns LoDashWrapper<number>

each

  • see

    _.forEach

    Type parameters

    • T: object

    Parameters

    Returns LoDashObjectWrapper<T>

eachRight

  • see

    _.forEachRight

    Type parameters

    • T: object

    Parameters

    • callback: ObjectIterator<T, void>

      The function called per iteration.

    • Optional thisArg: any

      The this binding of callback.

    Returns LoDashObjectWrapper<Dictionary<T>>

eq

  • eq(other?: any, callback?: EqCustomizer, thisArg?: any): boolean
  • see

    _.isEqual

    Parameters

    • Optional other: any
    • Optional callback: EqCustomizer
    • Optional thisArg: any

    Returns boolean

extend

  • extend<S1, Value, TResult>(s1: S1, callback?: function, thisArg?: any): TResult
  • extend<S1, S2, Value, TResult>(s1: S1, s2: S2, callback?: function, thisArg?: any): TResult
  • extend<S1, S2, S3, Value, TResult>(s1: S1, s2: S2, s3: S3, callback?: function, thisArg?: any): TResult
  • extend<S1, S2, S3, S4, Value, TResult>(s1: S1, s2: S2, s3: S3, s4: S4, callback?: function, thisArg?: any): TResult
  • extend<S1, S2, S3, S4, S5, Value, TResult>(s1: S1, s2: S2, s3: S3, s4: S4, s5: S5, callback?: function, thisArg?: any): TResult
  • see

    _.assign

    Type parameters

    • S1

    • Value

    • TResult

    Parameters

    • s1: S1
    • Optional callback: function
        • (objectValue: Value, sourceValue: Value): Value
        • Parameters

          • objectValue: Value
          • sourceValue: Value

          Returns Value

    • Optional thisArg: any

    Returns TResult

  • see

    _.assign

    Type parameters

    • S1

    • S2

    • Value

    • TResult

    Parameters

    • s1: S1
    • s2: S2
    • Optional callback: function
        • (objectValue: Value, sourceValue: Value): Value
        • Parameters

          • objectValue: Value
          • sourceValue: Value

          Returns Value

    • Optional thisArg: any

    Returns TResult

  • see

    _.assign

    Type parameters

    • S1

    • S2

    • S3

    • Value

    • TResult

    Parameters

    • s1: S1
    • s2: S2
    • s3: S3
    • Optional callback: function
        • (objectValue: Value, sourceValue: Value): Value
        • Parameters

          • objectValue: Value
          • sourceValue: Value

          Returns Value

    • Optional thisArg: any

    Returns TResult

  • see

    _.assign

    Type parameters

    • S1

    • S2

    • S3

    • S4

    • Value

    • TResult

    Parameters

    • s1: S1
    • s2: S2
    • s3: S3
    • s4: S4
    • Optional callback: function
        • (objectValue: Value, sourceValue: Value): Value
        • Parameters

          • objectValue: Value
          • sourceValue: Value

          Returns Value

    • Optional thisArg: any

    Returns TResult

  • see

    _.assign

    Type parameters

    • S1

    • S2

    • S3

    • S4

    • S5

    • Value

    • TResult

    Parameters

    • s1: S1
    • s2: S2
    • s3: S3
    • s4: S4
    • s5: S5
    • Optional callback: function
        • (objectValue: Value, sourceValue: Value): Value
        • Parameters

          • objectValue: Value
          • sourceValue: Value

          Returns Value

    • Optional thisArg: any

    Returns TResult

fill

  • see

    _.fill

    Type parameters

    • TResult

    Parameters

    • value: TResult
    • Optional start: number
    • Optional end: number

    Returns LoDashObjectWrapper<List<TResult>>

filter

  • see

    _.filter

    Type parameters

    • T: object

    Parameters

    Returns LoDashObjectWrapper<T>

flow

  • see

    _.flow

    Type parameters

    • TResult: Function

    Parameters

    • Rest ...funcs: Function[]

    Returns LoDashObjectWrapper<TResult>

flowRight

  • see

    _.flowRight

    Type parameters

    • TResult: Function

    Parameters

    • Rest ...funcs: Function[]

    Returns LoDashObjectWrapper<TResult>

foldl

  • foldl<TValue, TResult>(callback: MemoIterator<TValue, TResult>, accumulator: TResult, thisArg?: any): TResult
  • foldl<TValue, TResult>(callback: MemoIterator<TValue, TResult>, thisArg?: any): TResult
  • see

    _.reduce

    Type parameters

    • TValue

    • TResult

    Parameters

    • callback: MemoIterator<TValue, TResult>
    • accumulator: TResult
    • Optional thisArg: any

    Returns TResult

  • see

    _.reduce

    Type parameters

    • TValue

    • TResult

    Parameters

    • callback: MemoIterator<TValue, TResult>
    • Optional thisArg: any

    Returns TResult

forEach

  • see

    _.forEach

    Type parameters

    • T: object

    Parameters

    Returns LoDashObjectWrapper<T>

forEachRight

forIn

  • see

    _.forIn

    Type parameters

    • T: object

    Parameters

    Returns LoDashObjectWrapper<T>

forInRight

  • see

    _.forInRight

    Type parameters

    • T: object

    Parameters

    Returns LoDashObjectWrapper<T>

forOwn

  • see

    _.forOwn

    Type parameters

    • T: object

    Parameters

    Returns LoDashObjectWrapper<T>

forOwnRight

  • see

    _.forOwnRight

    Type parameters

    • T: object

    Parameters

    Returns LoDashObjectWrapper<T>

functions

  • see

    _.functions

    Returns LoDashArrayWrapper<string>

get

  • get<TResult>(path: string | string[], defaultValue?: TResult): TResult
  • see

    _.get

    Type parameters

    • TResult

    Parameters

    • path: string | string[]
    • Optional defaultValue: TResult

    Returns TResult

groupBy

  • see

    _.groupBy

    Type parameters

    • TValue

    Parameters

    Returns LoDashObjectWrapper<Dictionary<TValue[]>>

  • see

    _.groupBy

    Type parameters

    • TValue

    Parameters

    • pluckValue: string

    Returns LoDashObjectWrapper<Dictionary<TValue[]>>

  • see

    _.groupBy

    Type parameters

    • W

    • TValue

    Parameters

    • whereValue: W

    Returns LoDashObjectWrapper<Dictionary<TValue[]>>

gt

  • gt(other: any): boolean
  • see

    _.gt

    Parameters

    • other: any

    Returns boolean

gte

  • gte(other: any): boolean
  • see

    _.gte

    Parameters

    • other: any

    Returns boolean

identity

  • identity(): T
  • see

    _.identity

    Returns T

include

  • include<TValue>(target: TValue, fromIndex?: number): boolean
  • see

    _.contains

    Type parameters

    • TValue

    Parameters

    • target: TValue
    • Optional fromIndex: number

    Returns boolean

includes

  • includes<TValue>(target: TValue, fromIndex?: number): boolean
  • see

    _.contains

    Type parameters

    • TValue

    Parameters

    • target: TValue
    • Optional fromIndex: number

    Returns boolean

inject

  • inject<TValue, TResult>(callback: MemoIterator<TValue, TResult>, accumulator: TResult, thisArg?: any): TResult
  • inject<TValue, TResult>(callback: MemoIterator<TValue, TResult>, thisArg?: any): TResult
  • see

    _.reduce

    Type parameters

    • TValue

    • TResult

    Parameters

    • callback: MemoIterator<TValue, TResult>
    • accumulator: TResult
    • Optional thisArg: any

    Returns TResult

  • see

    _.reduce

    Type parameters

    • TValue

    • TResult

    Parameters

    • callback: MemoIterator<TValue, TResult>
    • Optional thisArg: any

    Returns TResult

isArguments

  • isArguments(): boolean

isArray

  • isArray(): boolean
  • see

    _.isArray

    Returns boolean

isBoolean

  • isBoolean(): boolean
  • see

    _.isBoolean

    Returns boolean

isDate

  • isDate(): boolean
  • see

    _.isDate

    Returns boolean

isElement

  • isElement(): boolean
  • see

    _.isElement

    Returns boolean

isEmpty

  • isEmpty(): boolean
  • see

    _.isEmpty

    Returns boolean

isEqual

  • isEqual(other?: any, callback?: EqCustomizer, thisArg?: any): boolean
  • see

    _.isEqual

    Parameters

    • Optional other: any
    • Optional callback: EqCustomizer
    • Optional thisArg: any

    Returns boolean

isError

  • isError(): boolean
  • see

    _.isError

    Returns boolean

isFinite

  • isFinite(): boolean
  • see

    _.isFinite

    Returns boolean

isFunction

  • isFunction(): boolean

isMatch

  • see

    _.isMatch

    Parameters

    Returns boolean

isNaN

  • isNaN(): boolean
  • see

    _.isNaN

    Returns boolean

isNative

  • isNative(): boolean
  • see _.isNative

    Returns boolean

isNull

  • isNull(): boolean
  • see _.isNull

    Returns boolean

isNumber

  • isNumber(): boolean
  • see _.isNumber

    Returns boolean

isObject

  • isObject(): boolean
  • see _.isObject

    Returns boolean

isPlainObject

  • isPlainObject(): boolean

isRegExp

  • isRegExp(): boolean
  • see _.isRegExp

    Returns boolean

isString

  • isString(): boolean
  • see _.isString

    Returns boolean

isTypedArray

  • isTypedArray(): boolean

isUndefined

  • isUndefined(): boolean

keys

  • see

    _.keys

    Returns LoDashArrayWrapper<string>

keysIn

  • see

    _.keysIn

    Returns LoDashArrayWrapper<string>

lt

  • lt(other: any): boolean
  • see

    _.lt

    Parameters

    • other: any

    Returns boolean

lte

  • lte(other: any): boolean
  • see

    _.lte

    Parameters

    • other: any

    Returns boolean

map

  • see

    _.map

    Type parameters

    • T: object

    • TResult

    Parameters

    Returns LoDashArrayWrapper<TResult>

mapValues

  • see

    _.mapValues TValue is the type of the property values of T. TResult is the type output by the ObjectIterator function

    Type parameters

    • TValue

    • TResult

    Parameters

    Returns LoDashObjectWrapper<Dictionary<TResult>>

  • see

    _.mapValues TResult is the type of the property specified by pluck. T should be a Dictionary>

    Type parameters

    • TResult

    Parameters

    • pluck: string

    Returns LoDashObjectWrapper<Dictionary<TResult>>

  • see

    _.mapValues TResult is the type of the properties on the object specified by pluck. T should be a Dictionary>>

    Type parameters

    • TResult

    Parameters

    Returns LoDashArrayWrapper<Dictionary<boolean>>

  • see

    _.mapValues TResult is the type of the properties of each object in the values of T T should be a Dictionary>

    Type parameters

    • TResult

    Parameters

    Returns LoDashArrayWrapper<boolean>

memoize

  • see

    _.memoize

    Type parameters

    Parameters

    • Optional resolver: Function

    Returns LoDashObjectWrapper<TResult>

methodOf

  • see

    _.methodOf

    Type parameters

    • TResult

    Parameters

    • Rest ...args: any[]

    Returns LoDashObjectWrapper<function>

methods

  • see

    _.functions

    Returns LoDashArrayWrapper<string>

modArgs

  • see

    _.modArgs

    Type parameters

    • TResult: Function

    Parameters

    • Rest ...transforms: Function[]

    Returns LoDashObjectWrapper<TResult>

  • see

    _.modArgs

    Type parameters

    • TResult: Function

    Parameters

    • transforms: Function[]

    Returns LoDashObjectWrapper<TResult>

negate

  • see

    _.negate

    Returns LoDashObjectWrapper<function>

  • see

    _.negate

    Type parameters

    • TResult: Function

    Returns LoDashObjectWrapper<TResult>

noop

  • noop(...args: any[]): void
  • see

    _.noop

    Parameters

    • Rest ...args: any[]

    Returns void

omit

  • see

    _.omit

    Type parameters

    • Omitted

    Parameters

    • Rest ...keys: string[]

    Returns LoDashObjectWrapper<Omitted>

  • see

    _.omit

    Type parameters

    • Omitted

    Parameters

    • keys: string[]

    Returns LoDashObjectWrapper<Omitted>

  • see

    _.omit

    Type parameters

    • Omitted

    Parameters

    Returns LoDashObjectWrapper<Omitted>

once

  • see

    _.once

    Returns LoDashObjectWrapper<T>

pairs

  • see

    _.pairs

    Returns LoDashArrayWrapper<any[]>

partition

  • see

    _.partition

    Type parameters

    • TResult

    Parameters

    • callback: ListIterator<TResult, boolean>
    • Optional thisArg: any

    Returns LoDashArrayWrapper<TResult[]>

  • see

    _.partition

    Type parameters

    • TResult

    Parameters

    Returns LoDashArrayWrapper<TResult[]>

  • see

    _.partition

    Type parameters

    • W

    • TResult

    Parameters

    • whereValue: W

    Returns LoDashArrayWrapper<TResult[]>

  • see

    _.partition

    Type parameters

    • TResult

    Parameters

    • path: string
    • srcValue: any

    Returns LoDashArrayWrapper<TResult[]>

  • see

    _.partition

    Type parameters

    • TResult

    Parameters

    • pluckValue: string

    Returns LoDashArrayWrapper<TResult[]>

pluck

  • see

    _.pluck

    Type parameters

    • TResult

    Parameters

    • property: string

    Returns LoDashArrayWrapper<TResult>

propertyOf

  • see

    _.propertyOf

    Returns LoDashObjectWrapper<function>

rearg

  • see

    _.rearg

    Type parameters

    • TResult: Function

    Parameters

    • indexes: number[]

    Returns LoDashObjectWrapper<TResult>

  • see

    _.rearg

    Type parameters

    • TResult: Function

    Parameters

    • Rest ...indexes: number[]

    Returns LoDashObjectWrapper<TResult>

reduce

  • reduce<TValue, TResult>(callback: MemoIterator<TValue, TResult>, accumulator: TResult, thisArg?: any): TResult
  • reduce<TValue, TResult>(callback: MemoIterator<TValue, TResult>, thisArg?: any): TResult
  • see

    _.reduce

    Type parameters

    • TValue

    • TResult

    Parameters

    • callback: MemoIterator<TValue, TResult>
    • accumulator: TResult
    • Optional thisArg: any

    Returns TResult

  • see

    _.reduce

    Type parameters

    • TValue

    • TResult

    Parameters

    • callback: MemoIterator<TValue, TResult>
    • Optional thisArg: any

    Returns TResult

restParam

  • see

    _.restParam

    Type parameters

    • TResult: Function

    Parameters

    • Optional start: number

    Returns LoDashObjectWrapper<TResult>

run

  • run(): T
  • see

    _.value

    Returns T

set

  • see

    _.set

    Parameters

    • path: string | string[]
    • value: any

    Returns LoDashObjectWrapper<T>

shuffle

  • see

    _.shuffle

    Returns LoDashArrayWrapper<T>

size

  • size(): number
  • see

    _.size

    Returns number

spread

  • see

    _.spread

    Type parameters

    • TResult: Function

    Returns LoDashObjectWrapper<TResult>

sum

  • sum(): number
  • sum(iteratee: ObjectIterator<any, number>, thisArg?: any): number
  • sum(property: string): number
  • see

    _.sum

    Returns number

  • see

    _.sum

    Parameters

    Returns number

  • see

    _.sum

    Parameters

    • property: string

      _.property callback shorthand.

    Returns number

tap

  • see

    _.tap

    Parameters

    • interceptor: function
        • (value: T): void
        • Parameters

          • value: T

          Returns void

    Returns LoDashObjectWrapper<T>

toArray

  • see

    _.toArray

    Type parameters

    • TValue

    Returns LoDashArrayWrapper<TValue>

toJSON

  • toJSON(): T
  • see

    _.value

    Returns T

toPlainObject

  • toPlainObject(): Object

toString

  • toString(): string
  • Produces the toString result of the wrapped value.

    Returns string

    Returns the string result.

value

  • value(): T
  • Executes the chained sequence to extract the unwrapped value.

    Returns T

    Returns the resolved unwrapped value.

valueOf

  • valueOf(): T

values

  • see

    _.values

    Type parameters

    • TResult

    Returns LoDashObjectWrapper<TResult[]>

valuesIn

  • see

    _.valuesIn

    Type parameters

    • TResult

    Returns LoDashObjectWrapper<TResult[]>

xor

  • see

    _.xor

    Parameters

    • Rest ...arrays: T[]

    Returns LoDashObjectWrapper<T>

LoDashStatic

  • Creates a lodash object which wraps the given value to enable intuitive method chaining.

    In addition to Lo-Dash methods, wrappers also have the following Array methods: concat, join, pop, push, reverse, shift, slice, sort, splice, and unshift

    Chaining is supported in custom builds as long as the value method is implicitly or explicitly included in the build.

    The chainable wrapper functions are: after, assign, bind, bindAll, bindKey, chain, chunk, compact, compose, concat, countBy, createCallback, curry, debounce, defaults, defer, delay, difference, filter, flatten, forEach, forEachRight, forIn, forInRight, forOwn, forOwnRight, functions, groupBy, indexBy, initial, intersection, invert, invoke, keys, map, max, memoize, merge, min, object, omit, once, pairs, partial, partialRight, pick, pluck, pull, push, range, reject, remove, rest, reverse, sample, shuffle, slice, sort, sortBy, splice, tap, throttle, times, toArray, transform, union, uniq, unshift, unzip, values, where, without, wrap, and zip

    The non-chainable wrapper functions are: clone, cloneDeep, contains, escape, every, find, findIndex, findKey, findLast, findLastIndex, findLastKey, has, identity, indexOf, isArguments, isArray, isBoolean, isDate, isElement, isEmpty, isEqual, isFinite, isFunction, isNaN, isNull, isNumber, isObject, isPlainObject, isRegExp, isString, isUndefined, join, lastIndexOf, mixin, noConflict, parseInt, pop, random, reduce, reduceRight, result, shift, size, some, sortedIndex, runInContext, template, unescape, uniqueId, and value

    The wrapper functions first and last return wrapped values when n is provided, otherwise they return unwrapped values.

    Explicit chaining can be enabled by using the _.chain method.

    Parameters

    • value: number

    Returns LoDashWrapper<number>

  • Arrays Date Functions Lang Math Number Object String Utility *

    Parameters

    • value: string

    Returns LoDashStringWrapper

  • Arrays Date Functions Lang Math Number Object String Utility *

    Parameters

    • value: boolean

    Returns LoDashWrapper<boolean>

  • Arrays Date Functions Lang Math Number Object String Utility *

    Parameters

    • value: Array<number>

    Returns LoDashNumberArrayWrapper

  • Arrays Date Functions Lang Math Number Object String Utility *

    Type parameters

    • T

    Parameters

    • value: Array<T>

    Returns LoDashArrayWrapper<T>

  • Arrays Date Functions Lang Math Number Object String Utility *

    Type parameters

    • T: object

    Parameters

    • value: T

    Returns LoDashObjectWrapper<T>

  • Arrays Date Functions Lang Math Number Object String Utility *

    Parameters

    • value: any

    Returns LoDashWrapper<any>

VERSION

VERSION: string

The semantic version number.

support

support: Support

An object used to flag environments features.

templateSettings

templateSettings: TemplateSettings

By default, the template delimiters used by Lo-Dash are similar to those in embedded Ruby (ERB). Change the following template settings to use alternative delimiters.

add

  • add(augend: number, addend: number): number
  • Adds two numbers.

    Parameters

    • augend: number

      The first number to add.

    • addend: number

      The second number to add.

    Returns number

    Returns the sum.

after

  • after(n: number, func: Function): Function
  • Creates a function that executes func, with the this binding and arguments of the created function, only after being called n times.

    Parameters

    • n: number

      The number of times the function must be called before func is executed.

    • func: Function

      The function to restrict.

    Returns Function

    The new restricted function.

all

  • all<T>(collection: Array<T>, callback?: ListIterator<T, boolean>, thisArg?: any): boolean
  • all<T>(collection: List<T>, callback?: ListIterator<T, boolean>, thisArg?: any): boolean
  • all<T>(collection: Dictionary<T>, callback?: DictionaryIterator<T, boolean>, thisArg?: any): boolean
  • all<T>(collection: Array<T>, pluckValue: string): boolean
  • all<T>(collection: List<T>, pluckValue: string): boolean
  • all<T>(collection: Dictionary<T>, pluckValue: string): boolean
  • all<W, T>(collection: Array<T>, whereValue: W): boolean
  • all<W, T>(collection: List<T>, whereValue: W): boolean
  • all<W, T>(collection: Dictionary<T>, whereValue: W): boolean
  • see

    _.every

    Type parameters

    • T

    Parameters

    • collection: Array<T>
    • Optional callback: ListIterator<T, boolean>
    • Optional thisArg: any

    Returns boolean

  • see

    _.every

    Type parameters

    • T

    Parameters

    • collection: List<T>
    • Optional callback: ListIterator<T, boolean>
    • Optional thisArg: any

    Returns boolean

  • see

    _.every

    Type parameters

    • T

    Parameters

    Returns boolean

  • see

    _.every

    Type parameters

    • T

    Parameters

    • collection: Array<T>
    • pluckValue: string

      _.pluck style callback

    Returns boolean

  • see

    _.every

    Type parameters

    • T

    Parameters

    • collection: List<T>
    • pluckValue: string

      _.pluck style callback

    Returns boolean

  • see

    _.every

    Type parameters

    • T

    Parameters

    • collection: Dictionary<T>
    • pluckValue: string

      _.pluck style callback

    Returns boolean

  • see

    _.every

    Type parameters

    • W

    • T

    Parameters

    • collection: Array<T>
    • whereValue: W

      _.where style callback

    Returns boolean

  • see

    _.every

    Type parameters

    • W

    • T

    Parameters

    • collection: List<T>
    • whereValue: W

      _.where style callback

    Returns boolean

  • see

    _.every

    Type parameters

    • W

    • T

    Parameters

    • collection: Dictionary<T>
    • whereValue: W

      _.where style callback

    Returns boolean

any

  • any<T>(collection: Array<T>, callback?: ListIterator<T, boolean>, thisArg?: any): boolean
  • any<T>(collection: List<T>, callback?: ListIterator<T, boolean>, thisArg?: any): boolean
  • any<T>(collection: Dictionary<T>, callback?: DictionaryIterator<T, boolean>, thisArg?: any): boolean
  • any(collection: object, callback?: ListIterator<object, boolean>, thisArg?: any): boolean
  • any<T>(collection: Array<T>, pluckValue: string): boolean
  • any<T>(collection: List<T>, pluckValue: string): boolean
  • any<T>(collection: Dictionary<T>, pluckValue: string): boolean
  • any<W, T>(collection: Array<T>, whereValue: W): boolean
  • any<W, T>(collection: List<T>, whereValue: W): boolean
  • any<W, T>(collection: Dictionary<T>, whereValue: W): boolean
  • see

    _.some

    Type parameters

    • T

    Parameters

    • collection: Array<T>
    • Optional callback: ListIterator<T, boolean>
    • Optional thisArg: any

    Returns boolean

  • see

    _.some

    Type parameters

    • T

    Parameters

    • collection: List<T>
    • Optional callback: ListIterator<T, boolean>
    • Optional thisArg: any

    Returns boolean

  • see

    _.some

    Type parameters

    • T

    Parameters

    Returns boolean

  • see

    _.some

    Parameters

    • collection: object
    • Optional callback: ListIterator<object, boolean>
    • Optional thisArg: any

    Returns boolean

  • see

    _.some

    Type parameters

    • T

    Parameters

    • collection: Array<T>
    • pluckValue: string

      _.pluck style callback

    Returns boolean

  • see

    _.some

    Type parameters

    • T

    Parameters

    • collection: List<T>
    • pluckValue: string

      _.pluck style callback

    Returns boolean

  • see

    _.some

    Type parameters

    • T

    Parameters

    • collection: Dictionary<T>
    • pluckValue: string

      _.pluck style callback

    Returns boolean

  • see

    _.some

    Type parameters

    • W

    • T

    Parameters

    • collection: Array<T>
    • whereValue: W

      _.where style callback

    Returns boolean

  • see

    _.some

    Type parameters

    • W

    • T

    Parameters

    • collection: List<T>
    • whereValue: W

      _.where style callback

    Returns boolean

  • see

    _.some

    Type parameters

    • W

    • T

    Parameters

    • collection: Dictionary<T>
    • whereValue: W

      _.where style callback

    Returns boolean

ary

  • ary<TResult>(func: Function, n?: number, guard?: Object): TResult
  • Creates a function that accepts up to n arguments ignoring any additional arguments.

    Type parameters

    • TResult: Function

    Parameters

    • func: Function

      The function to cap arguments for.

    • Optional n: number

      The arity cap.

    • Optional guard: Object

      Enables use as a callback for functions like _.map.

    Returns TResult

    Returns the new function.

assign

  • assign<P, T, S1, Value, Result>(object: T, s1: S1, callback?: function, thisArg?: any): Result
  • assign<P, T, S1, S2, Value, Result>(object: T, s1: S1, s2: S2, callback?: function, thisArg?: any): Result
  • assign<P, T, S1, S2, S3, Value, Result>(object: T, s1: S1, s2: S2, s3: S3, callback?: function, thisArg?: any): Result
  • assign<P, T, S1, S2, S3, S4, Value, Result>(object: T, s1: S1, s2: S2, s3: S3, s4: S4, callback?: function, thisArg?: any): Result
  • Assigns own enumerable properties of source object(s) to the destination object. Subsequent sources will overwrite property assignments of previous sources. If a callback is provided it will be executed to produce the assigned values. The callback is bound to thisArg and invoked with two arguments; (objectValue, sourceValue).

    Type parameters

    • P

    • T

    • S1

    • Value

    • Result

    Parameters

    • object: T

      The destination object.

    • s1: S1
    • Optional callback: function

      The function to customize merging properties.

        • (objectValue: Value, sourceValue: Value): Value
        • Parameters

          • objectValue: Value
          • sourceValue: Value

          Returns Value

    • Optional thisArg: any

      The this binding of callback.

    Returns Result

    The destination object.

  • see

    _.assign

    Type parameters

    • P

    • T

    • S1

    • S2

    • Value

    • Result

    Parameters

    • object: T
    • s1: S1
    • s2: S2
    • Optional callback: function
        • (objectValue: Value, sourceValue: Value): Value
        • Parameters

          • objectValue: Value
          • sourceValue: Value

          Returns Value

    • Optional thisArg: any

    Returns Result

  • see

    _.assign

    Type parameters

    • P

    • T

    • S1

    • S2

    • S3

    • Value

    • Result

    Parameters

    • object: T
    • s1: S1
    • s2: S2
    • s3: S3
    • Optional callback: function
        • (objectValue: Value, sourceValue: Value): Value
        • Parameters

          • objectValue: Value
          • sourceValue: Value

          Returns Value

    • Optional thisArg: any

    Returns Result

  • see

    _.assign

    Type parameters

    • P

    • T

    • S1

    • S2

    • S3

    • S4

    • Value

    • Result

    Parameters

    • object: T
    • s1: S1
    • s2: S2
    • s3: S3
    • s4: S4
    • Optional callback: function
        • (objectValue: Value, sourceValue: Value): Value
        • Parameters

          • objectValue: Value
          • sourceValue: Value

          Returns Value

    • Optional thisArg: any

    Returns Result

at

  • at<T>(collection: Array<T>, indexes: number[]): T[]
  • at<T>(collection: List<T>, indexes: number[]): T[]
  • at<T>(collection: Dictionary<T>, indexes: number[]): T[]
  • at<T>(collection: Array<T>, ...indexes: number[]): T[]
  • at<T>(collection: List<T>, ...indexes: number[]): T[]
  • at<T>(collection: Dictionary<T>, ...indexes: number[]): T[]
  • Creates an array of elements from the specified indexes, or keys, of the collection. Indexes may be specified as individual arguments or as arrays of indexes.

    Type parameters

    • T

    Parameters

    • collection: Array<T>

      The collection to iterate over.

    • indexes: number[]

      The indexes of collection to retrieve, specified as individual indexes or arrays of indexes.

    Returns T[]

    A new array of elements corresponding to the provided indexes.

  • see

    _.at

    Type parameters

    • T

    Parameters

    • collection: List<T>
    • indexes: number[]

    Returns T[]

  • see

    _.at

    Type parameters

    • T

    Parameters

    Returns T[]

  • see

    _.at

    Type parameters

    • T

    Parameters

    • collection: Array<T>
    • Rest ...indexes: number[]

    Returns T[]

  • see

    _.at

    Type parameters

    • T

    Parameters

    • collection: List<T>
    • Rest ...indexes: number[]

    Returns T[]

  • see

    _.at

    Type parameters

    • T

    Parameters

    • collection: Dictionary<T>
    • Rest ...indexes: number[]

    Returns T[]

attempt

  • attempt<TResult>(func: function): TResult | Error
  • Attempts to invoke func, returning either the result or the caught error object. Any additional arguments are provided to func when it’s invoked.

    Type parameters

    • TResult

    Parameters

    • func: function

      The function to attempt.

        • (...args: any[]): TResult
        • Parameters

          • Rest ...args: any[]

          Returns TResult

    Returns TResult | Error

    Returns the func result or error object.

backflow

  • backflow<TResult>(...funcs: Function[]): TResult
  • see

    _.flowRight

    Type parameters

    • TResult: Function

    Parameters

    • Rest ...funcs: Function[]

    Returns TResult

before

  • before<TFunc>(n: number, func: TFunc): TFunc
  • Creates a function that invokes func, with the this binding and arguments of the created function, while it is called less than n times. Subsequent calls to the created function return the result of the last func invocation.

    Type parameters

    • TFunc: Function

    Parameters

    • n: number

      The number of calls at which func is no longer invoked.

    • func: TFunc

      The function to restrict.

    Returns TFunc

    Returns the new restricted function.

bind

  • bind(func: Function, thisArg: any, ...args: any[]): function
  • Creates a function that, when called, invokes func with the this binding of thisArg and prepends any additional bind arguments to those provided to the bound function.

    Parameters

    • func: Function

      The function to bind.

    • thisArg: any

      The this binding of func.

    • Rest ...args: any[]

      Arguments to be partially applied.

    Returns function

    The new bound function.

      • (...args: any[]): any
      • Parameters

        • Rest ...args: any[]

        Returns any

bindAll

  • bindAll<T>(object: T, ...methodNames: string[]): T
  • Binds methods of an object to the object itself, overwriting the existing method. Method names may be specified as individual arguments or as arrays of method names. If no method names are provided all the function properties of object will be bound.

    Type parameters

    • T

    Parameters

    • object: T

      The object to bind and assign the bound methods to.

    • Rest ...methodNames: string[]

      The object method names to bind, specified as individual method names or arrays of method names.

    Returns T

    object

bindKey

  • bindKey<T>(object: T, key: string, ...args: any[]): Function
  • Creates a function that, when called, invokes the method at object[key] and prepends any additional bindKey arguments to those provided to the bound function. This method differs from _.bind by allowing bound functions to reference methods that will be redefined or don't yet exist. See http://michaux.ca/articles/lazy-function-definition-pattern.

    Type parameters

    • T

    Parameters

    • object: T

      The object the method belongs to.

    • key: string

      The key of the method.

    • Rest ...args: any[]

      Arguments to be partially applied.

    Returns Function

    The new bound function.

camelCase

  • camelCase(string?: string): string
  • Converts string to camel case.

    Parameters

    • Optional string: string

      The string to convert.

    Returns string

    Returns the camel cased string.

capitalize

  • capitalize(string?: string): string
  • Parameters

    • Optional string: string

    Returns string

ceil

  • ceil(n: number, precision?: number): number
  • Calculates n rounded up to precision.

    Parameters

    • n: number

      The number to round up.

    • Optional precision: number

      The precision to round up to.

    Returns number

    Returns the rounded up number.

chain

  • Creates a lodash object that wraps the given value with explicit method chaining enabled.

    Parameters

    • value: number

      The value to wrap.

    Returns LoDashWrapper<number>

    The wrapper object.

  • Parameters

    • value: string

    Returns LoDashWrapper<string>

  • Parameters

    • value: boolean

    Returns LoDashWrapper<boolean>

  • Type parameters

    • T

    Parameters

    • value: Array<T>

    Returns LoDashArrayWrapper<T>

  • Type parameters

    • T: object

    Parameters

    • value: T

    Returns LoDashObjectWrapper<T>

  • Parameters

    • value: any

    Returns LoDashWrapper<any>

chunk

  • chunk<T>(array: Array<T>, size?: number): T[]
  • chunk<T>(array: List<T>, size?: number): T[]
  • Creates an array of elements split into groups the length of size. If collection can't be split evenly, the final chunk will be the remaining elements.

    Type parameters

    • T

    Parameters

    • array: Array<T>

      The array to process.

    • Optional size: number

      The length of each chunk.

    Returns T[]

    Returns the new array containing chunks.

  • see

    _.chunk

    Type parameters

    • T

    Parameters

    • array: List<T>
    • Optional size: number

    Returns T[]

clone

  • clone<T>(value: T, isDeep?: boolean, customizer?: function, thisArg?: any): T
  • clone<T>(value: T, customizer?: function, thisArg?: any): T
  • Creates a clone of value. If isDeep is true nested objects are cloned, otherwise they are assigned by reference. If customizer is provided it’s invoked to produce the cloned values. If customizer returns undefined cloning is handled by the method instead. The customizer is bound to thisArg and invoked with up to three argument; (value [, index|key, object]). Note: This method is loosely based on the structured clone algorithm. The enumerable properties of arguments objects and objects created by constructors other than Object are cloned to plain Object objects. An empty object is returned for uncloneable values such as functions, DOM nodes, Maps, Sets, and WeakMaps.

    Type parameters

    • T

    Parameters

    • value: T

      The value to clone.

    • Optional isDeep: boolean

      Specify a deep clone.

    • Optional customizer: function

      The function to customize cloning values.

        • (value: any): any
        • Parameters

          • value: any

          Returns any

    • Optional thisArg: any

      The this binding of customizer.

    Returns T

    Returns the cloned value.

  • see

    _.clone

    Type parameters

    • T

    Parameters

    • value: T
    • Optional customizer: function
        • (value: any): any
        • Parameters

          • value: any

          Returns any

    • Optional thisArg: any

    Returns T

cloneDeep

  • cloneDeep<T>(value: T, customizer?: function, thisArg?: any): T
  • Creates a deep clone of value. If customizer is provided it’s invoked to produce the cloned values. If customizer returns undefined cloning is handled by the method instead. The customizer is bound to thisArg and invoked with up to three argument; (value [, index|key, object]). Note: This method is loosely based on the structured clone algorithm. The enumerable properties of arguments objects and objects created by constructors other than Object are cloned to plain Object objects. An empty object is returned for uncloneable values such as functions, DOM nodes, Maps, Sets, and WeakMaps.

    Type parameters

    • T

    Parameters

    • value: T

      The value to deep clone.

    • Optional customizer: function

      The function to customize cloning values.

        • (value: any): any
        • Parameters

          • value: any

          Returns any

    • Optional thisArg: any

      The this binding of customizer.

    Returns T

    Returns the deep cloned value.

collect

  • collect<T, TResult>(collection: Array<T>, callback: ListIterator<T, TResult>, thisArg?: any): TResult[]
  • collect<T, TResult>(collection: List<T>, callback: ListIterator<T, TResult>, thisArg?: any): TResult[]
  • collect<T, TResult>(object: Dictionary<T>, callback: DictionaryIterator<T, TResult>, thisArg?: any): TResult[]
  • collect<T, TResult>(collection: Array<T>, pluckValue: string): TResult[]
  • collect<T, TResult>(collection: List<T>, pluckValue: string): TResult[]
  • see

    _.map

    Type parameters

    • T

    • TResult

    Parameters

    • collection: Array<T>
    • callback: ListIterator<T, TResult>
    • Optional thisArg: any

    Returns TResult[]

  • see

    _.map

    Type parameters

    • T

    • TResult

    Parameters

    Returns TResult[]

  • see

    _.map

    Type parameters

    • T: object

    • TResult

    Parameters

    Returns TResult[]

  • see

    _.map

    Type parameters

    • T

    • TResult

    Parameters

    • collection: Array<T>
    • pluckValue: string

    Returns TResult[]

  • see

    _.map

    Type parameters

    • T

    • TResult

    Parameters

    • collection: List<T>
    • pluckValue: string

    Returns TResult[]

compact

  • compact<T>(array?: Array<T>): T[]
  • compact<T>(array?: List<T>): T[]
  • Returns a copy of the array with all falsy values removed. In JavaScript, false, null, 0, "", undefined and NaN are all falsy.

    Type parameters

    • T

    Parameters

    • Optional array: Array<T>

      Array to compact.

    Returns T[]

    (Array) Returns a new array of filtered values.

  • see

    _.compact

    Type parameters

    • T

    Parameters

    • Optional array: List<T>

    Returns T[]

compose

  • compose<TResult>(...funcs: Function[]): TResult
  • see

    _.flowRight

    Type parameters

    • TResult: Function

    Parameters

    • Rest ...funcs: Function[]

    Returns TResult

constant

  • constant<T>(value: T): function
  • Creates a function that returns value.

    Type parameters

    • T

    Parameters

    • value: T

      The value to return from the new function.

    Returns function

    Returns the new function.

      • (): T
      • Returns T

contains

  • contains<T>(collection: Array<T>, target: T, fromIndex?: number): boolean
  • contains<T>(collection: List<T>, target: T, fromIndex?: number): boolean
  • contains<T>(dictionary: Dictionary<T>, value: T, fromIndex?: number): boolean
  • contains(searchString: string, targetString: string, fromIndex?: number): boolean
  • Checks if a given value is present in a collection using strict equality for comparisons, i.e. ===. If fromIndex is negative, it is used as the offset from the end of the collection.

    Type parameters

    • T

    Parameters

    • collection: Array<T>

      The collection to iterate over.

    • target: T

      The value to check for.

    • Optional fromIndex: number

      The index to search from.

    Returns boolean

    True if the target element is found, else false.

  • see

    _.contains

    Type parameters

    • T

    Parameters

    • collection: List<T>
    • target: T
    • Optional fromIndex: number

    Returns boolean

  • see

    _.contains

    Type parameters

    • T

    Parameters

    • dictionary: Dictionary<T>

      The dictionary to iterate over.

    • value: T

      The value in the dictionary to search for.

    • Optional fromIndex: number

    Returns boolean

  • see

    _.contains

    Parameters

    • searchString: string

      the string to search

    • targetString: string

      the string to search for

    • Optional fromIndex: number

    Returns boolean

countBy

  • Creates an object composed of keys generated from the results of running each element of collection through the callback. The corresponding value of each key is the number of times the key was returned by the callback. The callback is bound to thisArg and invoked with three arguments; (value, index|key, collection).

    If a property name is provided for callback the created "_.pluck" style callback will return the property value of the given element.

    If an object is provided for callback the created "_.where" style callback will return true for elements that have the properties of the given object, else false.

    Type parameters

    • T

    Parameters

    • collection: Array<T>

      The collection to iterate over.

    • Optional callback: ListIterator<T, any>

      The function called per iteration.

    • Optional thisArg: any

      The this binding of callback.

    Returns Dictionary<number>

    Returns the composed aggregate object.

  • see

    _.countBy

    Type parameters

    • T

    Parameters

    • collection: List<T>
    • Optional callback: ListIterator<T, any>

      Function name

    • Optional thisArg: any

    Returns Dictionary<number>

  • see

    _.countBy

    Type parameters

    • T

    Parameters

    Returns Dictionary<number>

  • see

    _.countBy

    Type parameters

    • T

    Parameters

    • collection: Array<T>
    • callback: string

      Function name

    • Optional thisArg: any

    Returns Dictionary<number>

  • see

    _.countBy

    Type parameters

    • T

    Parameters

    • collection: List<T>
    • callback: string

      Function name

    • Optional thisArg: any

    Returns Dictionary<number>

  • see

    _.countBy

    Type parameters

    • T

    Parameters

    • collection: Dictionary<T>
    • callback: string

      Function name

    • Optional thisArg: any

    Returns Dictionary<number>

create

  • create<TResult>(prototype: Object, properties?: Object): TResult
  • Creates an object that inherits from the given prototype object. If a properties object is provided its own enumerable properties are assigned to the created object.

    Type parameters

    • TResult: object

    Parameters

    • prototype: Object

      The object to inherit from.

    • Optional properties: Object

      The properties to assign to the object.

    Returns TResult

    Returns the new object.

createCallback

  • createCallback(func: string, thisArg?: any, argCount?: number): function
  • createCallback(func: Dictionary<any>, thisArg?: any, argCount?: number): function
  • Produces a callback bound to an optional thisArg. If func is a property name the created callback will return the property value for a given element. If func is an object the created callback will return true for elements that contain the equivalent object properties, otherwise it will return false.

    Parameters

    • func: string

      The value to convert to a callback.

    • Optional thisArg: any

      The this binding of the created callback.

    • Optional argCount: number

      The number of arguments the callback accepts.

    Returns function

    A callback function.

      • (): any
      • Returns any

  • see

    _.createCallback

    Parameters

    • func: Dictionary<any>
    • Optional thisArg: any
    • Optional argCount: number

    Returns function

      • (): boolean
      • Returns boolean

curry

  • curry<TResult>(func: Function, arity?: number): TResult
  • Creates a function that accepts one or more arguments of func that when called either invokes func returning its result, if all func arguments have been provided, or returns a function that accepts one or more of the remaining func arguments, and so on. The arity of func may be specified if func.length is not sufficient.

    Type parameters

    • TResult: Function

    Parameters

    • func: Function

      The function to curry.

    • Optional arity: number

      The arity of func.

    Returns TResult

    Returns the new curried function.

curryRight

  • curryRight<TResult>(func: Function, arity?: number): TResult
  • This method is like .curry except that arguments are applied to func in the manner of .partialRight instead of _.partial.

    Type parameters

    • TResult: Function

    Parameters

    • func: Function

      The function to curry.

    • Optional arity: number

      The arity of func.

    Returns TResult

    Returns the new curried function.

debounce

  • Creates a function that will delay the execution of func until after wait milliseconds have elapsed since the last time it was invoked. Provide an options object to indicate that func should be invoked on the leading and/or trailing edge of the wait timeout. Subsequent calls to the debounced function will return the result of the last func call.

    Note: If leading and trailing options are true func will be called on the trailing edge of the timeout only if the the debounced function is invoked more than once during the wait timeout.

    Type parameters

    • T: Function

    Parameters

    • func: T

      The function to debounce.

    • wait: number

      The number of milliseconds to delay.

    • Optional options: DebounceSettings

      The options object.

    Returns T

    The new debounced function.

deburr

  • deburr(string?: string): string
  • Deburrs string by converting latin-1 supplementary letters to basic latin letters and removing combining diacritical marks.

    Parameters

    • Optional string: string

      The string to deburr.

    Returns string

    Returns the deburred string.

defaults

  • defaults<T, TResult>(object: T, ...sources: any[]): TResult
  • Assigns own enumerable properties of source object(s) to the destination object for all destination properties that resolve to undefined. Once a property is set, additional defaults of the same property will be ignored.

    Type parameters

    • T

    • TResult

    Parameters

    • object: T

      The destination object.

    • Rest ...sources: any[]

      The source objects.

    Returns TResult

    The destination object.

defaultsDeep

  • defaultsDeep<T, TResult>(object: T, ...sources: any[]): TResult
  • This method is like _.defaults except that it recursively assigns default properties.

    Type parameters

    • T

    • TResult

    Parameters

    • object: T

      The destination object.

    • Rest ...sources: any[]

      The source objects.

    Returns TResult

    Returns object.

defer

  • defer(func: Function, ...args: any[]): number
  • Defers executing the func function until the current call stack has cleared. Additional arguments will be provided to func when it is invoked.

    Parameters

    • func: Function

      The function to defer.

    • Rest ...args: any[]

      Arguments to invoke the function with.

    Returns number

    The timer id.

delay

  • delay(func: Function, wait: number, ...args: any[]): number
  • Executes the func function after wait milliseconds. Additional arguments will be provided to func when it is invoked.

    Parameters

    • func: Function

      The function to delay.

    • wait: number

      The number of milliseconds to delay execution.

    • Rest ...args: any[]

      Arguments to invoke the function with.

    Returns number

    The timer id.

detect

  • detect<T>(collection: Array<T>, callback: ListIterator<T, boolean>, thisArg?: any): T
  • detect<T>(collection: List<T>, callback: ListIterator<T, boolean>, thisArg?: any): T
  • detect<T>(collection: Dictionary<T>, callback: DictionaryIterator<T, boolean>, thisArg?: any): T
  • detect<W, T>(collection: Array<T> | List<T> | Dictionary<T>, whereValue: W): T
  • detect<T>(collection: Array<T> | List<T> | Dictionary<T>, path: string, srcValue: any): T
  • detect<T>(collection: Array<T> | List<T> | Dictionary<T>, pluckValue: string): T
  • Alias of _.find

    see

    _.find

    Type parameters

    • T

    Parameters

    • collection: Array<T>
    • callback: ListIterator<T, boolean>
    • Optional thisArg: any

    Returns T

  • Alias of _.find

    see

    _.find

    Type parameters

    • T

    Parameters

    Returns T

  • Alias of _.find

    see

    _.find

    Type parameters

    • T

    Parameters

    Returns T

  • Alias of _.find

    see

    _.find

    Type parameters

    • W

    • T

    Parameters

    Returns T

  • Alias of _.find

    see

    _.find

    Type parameters

    • T

    Parameters

    • collection: Array<T> | List<T> | Dictionary<T>
    • path: string
    • srcValue: any

    Returns T

  • Alias of _.find

    see

    _.find

    Type parameters

    • T

    Parameters

    Returns T

difference

  • difference<T>(array?: Array<T>, ...others: Array<T>[]): T[]
  • difference<T>(array?: List<T>, ...others: List<T>[]): T[]
  • Creates an array excluding all values of the provided arrays using strict equality for comparisons , i.e. ===.

    Type parameters

    • T

    Parameters

    • Optional array: Array<T>

      The array to process

    • Rest ...others: Array<T>[]

      The arrays of values to exclude.

    Returns T[]

    Returns a new array of filtered values.

  • see

    _.difference

    Type parameters

    • T

    Parameters

    • Optional array: List<T>
    • Rest ...others: List<T>[]

    Returns T[]

drop

  • drop<T>(array: Array<T>): T[]
  • drop<T>(array: List<T>): T[]
  • drop<T>(array: Array<T>, callback: ListIterator<T, boolean>, thisArg?: any): T[]
  • drop<T>(array: List<T>, callback: ListIterator<T, boolean>, thisArg?: any): T[]
  • drop<T>(array: Array<T>, n: number): T[]
  • drop<T>(array: List<T>, n: number): T[]
  • drop<T>(array: Array<T>, pluckValue: string): T[]
  • drop<T>(array: List<T>, pluckValue: string): T[]
  • drop<W, T>(array: Array<T>, whereValue: W): T[]
  • drop<W, T>(array: List<T>, whereValue: W): T[]
  • see

    _.rest

    Type parameters

    • T

    Parameters

    • array: Array<T>

    Returns T[]

  • see

    _.rest

    Type parameters

    • T

    Parameters

    Returns T[]

  • see

    _.rest

    Type parameters

    • T

    Parameters

    • array: Array<T>
    • callback: ListIterator<T, boolean>
    • Optional thisArg: any

    Returns T[]

  • see

    _.rest

    Type parameters

    • T

    Parameters

    Returns T[]

  • see

    _.rest

    Type parameters

    • T

    Parameters

    • array: Array<T>
    • n: number

    Returns T[]

  • see

    _.rest

    Type parameters

    • T

    Parameters

    • array: List<T>
    • n: number

    Returns T[]

  • see

    _.rest

    Type parameters

    • T

    Parameters

    • array: Array<T>
    • pluckValue: string

    Returns T[]

  • see

    _.rest

    Type parameters

    • T

    Parameters

    • array: List<T>
    • pluckValue: string

    Returns T[]

  • see

    _.rest

    Type parameters

    • W

    • T

    Parameters

    • array: Array<T>
    • whereValue: W

    Returns T[]

  • see

    _.rest

    Type parameters

    • W

    • T

    Parameters

    • array: List<T>
    • whereValue: W

    Returns T[]

each

  • see

    _.forEach

    Type parameters

    • T

    Parameters

    • collection: Array<T>
    • callback: ListIterator<T, void>
    • Optional thisArg: any

    Returns Array<T>

  • see

    _.forEach

    Type parameters

    • T

    Parameters

    Returns List<T>

  • see

    _.forEach

    Type parameters

    • T: object

    Parameters

    • object: Dictionary<T>

      The object to iterate over

    • callback: DictionaryIterator<T, void>

      The function called per iteration.

    • Optional thisArg: any

      The this binding of callback.

    Returns Dictionary<T>

  • see

    _.each

    Type parameters

    • T: object

    • TValue

    Parameters

    • object: T
    • callback: ObjectIterator<TValue, void>
    • Optional thisArg: any

    Returns T

eachRight

  • see

    _.forEachRight

    Type parameters

    • T

    Parameters

    • collection: Array<T>
    • callback: ListIterator<T, void>
    • Optional thisArg: any

    Returns Array<T>

  • see

    _.forEachRight

    Type parameters

    • T

    Parameters

    Returns List<T>

  • see

    _.forEachRight

    Type parameters

    • T: object

    Parameters

    • object: Dictionary<T>

      The object to iterate over

    • callback: DictionaryIterator<T, void>

      The function called per iteration.

    • Optional thisArg: any

      The this binding of callback.

    Returns Dictionary<T>

endsWith

  • endsWith(string?: string, target?: string, position?: number): boolean
  • Checks if string ends with the given target string.

    Parameters

    • Optional string: string

      The string to search.

    • Optional target: string

      The string to search for.

    • Optional position: number

      The position to search from.

    Returns boolean

    Returns true if string ends with target, else false.

eq

  • eq(value?: any, other?: any, callback?: EqCustomizer, thisArg?: any): boolean
  • see

    _.isEqual

    Parameters

    • Optional value: any
    • Optional other: any
    • Optional callback: EqCustomizer
    • Optional thisArg: any

    Returns boolean

escape

  • escape(string?: string): string
  • Converts the characters "&", "<", ">", '"', "'", and "`", in string to their corresponding HTML entities.

    Parameters

    • Optional string: string

      The string to escape.

    Returns string

    Returns the escaped string.

escapeRegExp

  • escapeRegExp(string?: string): string
  • Escapes the RegExp special characters "\", "/", "^", "$", ".", "|", "?", "*", "+", "(", ")", "[", "]", "{" and "}" in string.

    Parameters

    • Optional string: string

      The string to escape.

    Returns string

    Returns the escaped string.

every

  • every<T>(collection: Array<T>, callback?: ListIterator<T, boolean>, thisArg?: any): boolean
  • every<T>(collection: List<T>, callback?: ListIterator<T, boolean>, thisArg?: any): boolean
  • every<T>(collection: Dictionary<T>, callback?: DictionaryIterator<T, boolean>, thisArg?: any): boolean
  • every<T>(collection: Array<T>, pluckValue: string): boolean
  • every<T>(collection: List<T>, pluckValue: string): boolean
  • every<T>(collection: Dictionary<T>, pluckValue: string): boolean
  • every<W, T>(collection: Array<T>, whereValue: W): boolean
  • every<W, T>(collection: List<T>, whereValue: W): boolean
  • every<W, T>(collection: Dictionary<T>, whereValue: W): boolean
  • Checks if the given callback returns truey value for all elements of a collection. The callback is bound to thisArg and invoked with three arguments; (value, index|key, collection).

    If a property name is provided for callback the created "_.pluck" style callback will return the property value of the given element.

    If an object is provided for callback the created "_.where" style callback will return true for elements that have the properties of the given object, else false.

    Type parameters

    • T

    Parameters

    • collection: Array<T>

      The collection to iterate over.

    • Optional callback: ListIterator<T, boolean>

      The function called per iteration.

    • Optional thisArg: any

      The this binding of callback.

    Returns boolean

    True if all elements passed the callback check, else false.

  • see

    _.every

    Type parameters

    • T

    Parameters

    • collection: List<T>
    • Optional callback: ListIterator<T, boolean>
    • Optional thisArg: any

    Returns boolean

  • see

    _.every

    Type parameters

    • T

    Parameters

    Returns boolean

  • see

    _.every

    Type parameters

    • T

    Parameters

    • collection: Array<T>
    • pluckValue: string

      _.pluck style callback

    Returns boolean

  • see

    _.every

    Type parameters

    • T

    Parameters

    • collection: List<T>
    • pluckValue: string

      _.pluck style callback

    Returns boolean

  • see

    _.every

    Type parameters

    • T

    Parameters

    • collection: Dictionary<T>
    • pluckValue: string

      _.pluck style callback

    Returns boolean

  • see

    _.every

    Type parameters

    • W

    • T

    Parameters

    • collection: Array<T>
    • whereValue: W

      _.where style callback

    Returns boolean

  • see

    _.every

    Type parameters

    • W

    • T

    Parameters

    • collection: List<T>
    • whereValue: W

      _.where style callback

    Returns boolean

  • see

    _.every

    Type parameters

    • W

    • T

    Parameters

    • collection: Dictionary<T>
    • whereValue: W

      _.where style callback

    Returns boolean

extend

  • extend<P, T, S1, Value, Result>(object: T, s1: S1, callback?: function, thisArg?: any): Result
  • extend<P, T, S1, S2, Value, Result>(object: T, s1: S1, s2: S2, callback?: function, thisArg?: any): Result
  • extend<P, T, S1, S2, S3, Value, Result>(object: T, s1: S1, s2: S2, s3: S3, callback?: function, thisArg?: any): Result
  • extend<P, T, S1, S2, S3, S4, Value, Result>(object: T, s1: S1, s2: S2, s3: S3, s4: S4, callback?: function, thisArg?: any): Result
  • see

    _.assign

    Type parameters

    • P

    • T

    • S1

    • Value

    • Result

    Parameters

    • object: T
    • s1: S1
    • Optional callback: function
        • (objectValue: Value, sourceValue: Value): Value
        • Parameters

          • objectValue: Value
          • sourceValue: Value

          Returns Value

    • Optional thisArg: any

    Returns Result

  • see

    _.assign

    Type parameters

    • P

    • T

    • S1

    • S2

    • Value

    • Result

    Parameters

    • object: T
    • s1: S1
    • s2: S2
    • Optional callback: function
        • (objectValue: Value, sourceValue: Value): Value
        • Parameters

          • objectValue: Value
          • sourceValue: Value

          Returns Value

    • Optional thisArg: any

    Returns Result

  • see

    _.assign

    Type parameters

    • P

    • T

    • S1

    • S2

    • S3

    • Value

    • Result

    Parameters

    • object: T
    • s1: S1
    • s2: S2
    • s3: S3
    • Optional callback: function
        • (objectValue: Value, sourceValue: Value): Value
        • Parameters

          • objectValue: Value
          • sourceValue: Value

          Returns Value

    • Optional thisArg: any

    Returns Result

  • see

    _.assign

    Type parameters

    • P

    • T

    • S1

    • S2

    • S3

    • S4

    • Value

    • Result

    Parameters

    • object: T
    • s1: S1
    • s2: S2
    • s3: S3
    • s4: S4
    • Optional callback: function
        • (objectValue: Value, sourceValue: Value): Value
        • Parameters

          • objectValue: Value
          • sourceValue: Value

          Returns Value

    • Optional thisArg: any

    Returns Result

fill

  • fill<TResult>(array: any[], value: any, start?: number, end?: number): TResult[]
  • fill<TResult>(array: List<any>, value: any, start?: number, end?: number): List<TResult>
  • Fills elements of array with value from start up to, but not including, end.

    Note: This method mutates array.

    Type parameters

    • TResult

    Parameters

    • array: any[]

      (Array): The array to fill.

    • value: any

      (*): The value to fill array with.

    • Optional start: number
    • Optional end: number

    Returns TResult[]

    (Array): Returns array.

  • see

    _.fill

    Type parameters

    • TResult

    Parameters

    • array: List<any>
    • value: any
    • Optional start: number
    • Optional end: number

    Returns List<TResult>

filter

  • filter<T>(collection: Array<T> | List<T>): T[]
  • filter<T>(collection: Array<T>, callback: ListIterator<T, boolean>, thisArg?: any): T[]
  • filter<T>(collection: List<T>, callback: ListIterator<T, boolean>, thisArg?: any): T[]
  • filter<T>(collection: Dictionary<T>, callback: DictionaryIterator<T, boolean>, thisArg?: any): T[]
  • filter<T>(collection: Array<T>, pluckValue: string): T[]
  • filter<T>(collection: List<T>, pluckValue: string): T[]
  • filter<T>(collection: Dictionary<T>, pluckValue: string): T[]
  • filter<W, T>(collection: Array<T>, whereValue: W): T[]
  • filter<W, T>(collection: List<T>, whereValue: W): T[]
  • filter<W, T>(collection: Dictionary<T>, whereValue: W): T[]
  • Iterates over elements of a collection, returning an array of all elements the identity function returns truey for.

    Type parameters

    • T

    Parameters

    • collection: Array<T> | List<T>

      The collection to iterate over.

    Returns T[]

    Returns a new array of elements that passed the callback check.

  • Iterates over elements of a collection, returning an array of all elements the callback returns truey for. The callback is bound to thisArg and invoked with three arguments; (value, index|key, collection).

    If a property name is provided for callback the created "_.pluck" style callback will return the property value of the given element.

    If an object is provided for callback the created "_.where" style callback will return true for elements that have the properties of the given object, else false.

    Type parameters

    • T

    Parameters

    • collection: Array<T>

      The collection to iterate over.

    • callback: ListIterator<T, boolean>

      The function called per iteration.

    • Optional thisArg: any

    Returns T[]

    Returns a new array of elements that passed the callback check.

  • see

    _.filter

    Type parameters

    • T

    Parameters

    Returns T[]

  • see

    _.filter

    Type parameters

    • T

    Parameters

    Returns T[]

  • see

    _.filter

    Type parameters

    • T

    Parameters

    • collection: Array<T>
    • pluckValue: string

      _.pluck style callback

    Returns T[]

  • see

    _.filter

    Type parameters

    • T

    Parameters

    • collection: List<T>
    • pluckValue: string

      _.pluck style callback

    Returns T[]

  • see

    _.filter

    Type parameters

    • T

    Parameters

    • collection: Dictionary<T>
    • pluckValue: string

      _.pluck style callback

    Returns T[]

  • see

    _.filter

    Type parameters

    • W

    • T

    Parameters

    • collection: Array<T>
    • whereValue: W

    Returns T[]

  • see

    _.filter

    Type parameters

    • W

    • T

    Parameters

    • collection: List<T>
    • whereValue: W

    Returns T[]

  • see

    _.filter

    Type parameters

    • W

    • T

    Parameters

    Returns T[]

find

  • find<T>(collection: Array<T>, callback: ListIterator<T, boolean>, thisArg?: any): T
  • find<T>(collection: List<T>, callback: ListIterator<T, boolean>, thisArg?: any): T
  • find<T>(collection: Dictionary<T>, callback: DictionaryIterator<T, boolean>, thisArg?: any): T
  • find<W, T>(collection: Array<T> | List<T> | Dictionary<T>, whereValue: W): T
  • find<T>(collection: Array<T> | List<T> | Dictionary<T>, path: string, srcValue: any): T
  • find<T>(collection: Array<T> | List<T> | Dictionary<T>, pluckValue: string): T
  • Iterates over elements of collection, returning the first element predicate returns truthy for. The predicate is bound to thisArg and invoked with three arguments: (value, index|key, collection).

    If a property name is provided for predicate the created _.property style callback returns the property value of the given element.

    If a value is also provided for thisArg the created _.matchesProperty style callback returns true for elements that have a matching property value, else false.

    If an object is provided for predicate the created _.matches style callback returns true for elements that have the properties of the given object, else false.

    Type parameters

    • T

    Parameters

    • collection: Array<T>

      Searches for a value in this list.

    • callback: ListIterator<T, boolean>

      The function called per iteration.

    • Optional thisArg: any

      The this binding of callback.

    Returns T

    The found element, else undefined.

  • see

    _.find

    Type parameters

    • T

    Parameters

    Returns T

  • see

    _.find

    Type parameters

    • T

    Parameters

    Returns T

  • see

    _.find

    Type parameters

    • W

    • T

    Parameters

    Returns T

  • see

    _.find

    Type parameters

    • T

    Parameters

    • collection: Array<T> | List<T> | Dictionary<T>
    • path: string
    • srcValue: any

    Returns T

  • see

    _.find

    Type parameters

    • T

    Parameters

    Returns T

findIndex

  • findIndex<T>(array: Array<T>, callback: ListIterator<T, boolean>, thisArg?: any): number
  • findIndex<T>(array: List<T>, callback: ListIterator<T, boolean>, thisArg?: any): number
  • findIndex<T>(array: Array<T>, pluckValue: string): number
  • findIndex<T>(array: List<T>, pluckValue: string): number
  • findIndex<W, T>(array: Array<T>, whereDictionary: W): number
  • findIndex<W, T>(array: List<T>, whereDictionary: W): number
  • This method is like _.find except that it returns the index of the first element that passes the callback check, instead of the element itself.

    Type parameters

    • T

    Parameters

    • array: Array<T>

      The array to search.

    • callback: ListIterator<T, boolean>

      The function called per iteration. If a property name or object is provided it will be used to create a ".pluck" or ".where" style callback, respectively.

    • Optional thisArg: any

      The this binding of callback.

    Returns number

    Returns the index of the found element, else -1.

  • see

    _.findIndex

    Type parameters

    • T

    Parameters

    Returns number

  • see

    _.findIndex

    Type parameters

    • T

    Parameters

    • array: Array<T>
    • pluckValue: string

    Returns number

  • see

    _.findIndex

    Type parameters

    • T

    Parameters

    • array: List<T>
    • pluckValue: string

    Returns number

  • see

    _.findIndex

    Type parameters

    • W

    • T

    Parameters

    • array: Array<T>
    • whereDictionary: W

    Returns number

  • see

    _.findIndex

    Type parameters

    • W

    • T

    Parameters

    • array: List<T>
    • whereDictionary: W

    Returns number

findKey

  • findKey(object: any, callback: function, thisArg?: any): string
  • findKey(object: any, pluckValue: string): string
  • findKey<W, T>(object: T, whereValue: W): string
  • This method is like _.findIndex except that it returns the key of the first element that passes the callback check, instead of the element itself.

    Parameters

    • object: any

      The object to search.

    • callback: function

      The function called per iteration.

        • (value: any): boolean
        • Parameters

          • value: any

          Returns boolean

    • Optional thisArg: any

      The this binding of callback.

    Returns string

    The key of the found element, else undefined.

  • see

    _.findKey

    Parameters

    • object: any
    • pluckValue: string

      _.pluck style callback

    Returns string

  • see

    _.findKey

    Type parameters

    Parameters

    • object: T
    • whereValue: W

      _.where style callback

    Returns string

findLast

  • findLast<T>(collection: Array<T>, callback: ListIterator<T, boolean>, thisArg?: any): T
  • findLast<T>(collection: List<T>, callback: ListIterator<T, boolean>, thisArg?: any): T
  • findLast<T>(collection: Dictionary<T>, callback: DictionaryIterator<T, boolean>, thisArg?: any): T
  • findLast<W, T>(collection: Array<T>, whereValue: W): T
  • findLast<W, T>(collection: List<T>, whereValue: W): T
  • findLast<W, T>(collection: Dictionary<T>, whereValue: W): T
  • findLast<T>(collection: Array<T>, pluckValue: string): T
  • findLast<T>(collection: List<T>, pluckValue: string): T
  • findLast<T>(collection: Dictionary<T>, pluckValue: string): T
  • This method is like _.find except that it iterates over elements of a collection from right to left.

    Type parameters

    • T

    Parameters

    • collection: Array<T>

      Searches for a value in this list.

    • callback: ListIterator<T, boolean>

      The function called per iteration.

    • Optional thisArg: any

      The this binding of callback.

    Returns T

    The found element, else undefined.

  • see

    _.find

    Type parameters

    • T

    Parameters

    Returns T

  • see

    _.find

    Type parameters

    • T

    Parameters

    Returns T

  • see

    _.find

    Type parameters

    • W

    • T

    Parameters

    • collection: Array<T>
    • whereValue: W

    Returns T

  • see

    _.find

    Type parameters

    • W

    • T

    Parameters

    • collection: List<T>
    • whereValue: W

    Returns T

  • see

    _.find

    Type parameters

    • W

    • T

    Parameters

    Returns T

  • see

    _.find

    Type parameters

    • T

    Parameters

    • collection: Array<T>
    • pluckValue: string

    Returns T

  • see

    _.find

    Type parameters

    • T

    Parameters

    • collection: List<T>
    • pluckValue: string

    Returns T

  • see

    _.find

    Type parameters

    • T

    Parameters

    Returns T

findLastIndex

  • findLastIndex<T>(array: Array<T>, callback: ListIterator<T, boolean>, thisArg?: any): number
  • findLastIndex<T>(array: List<T>, callback: ListIterator<T, boolean>, thisArg?: any): number
  • findLastIndex<T>(array: Array<T>, pluckValue: string): number
  • findLastIndex<T>(array: List<T>, pluckValue: string): number
  • findLastIndex<T>(array: Array<T>, whereDictionary: Dictionary<any>): number
  • findLastIndex<T>(array: List<T>, whereDictionary: Dictionary<any>): number
  • This method is like _.findIndex except that it iterates over elements of a collection from right to left.

    Type parameters

    • T

    Parameters

    • array: Array<T>

      The array to search.

    • callback: ListIterator<T, boolean>

      The function called per iteration. If a property name or object is provided it will be used to create a ".pluck" or ".where" style callback, respectively.

    • Optional thisArg: any

      The this binding of callback.

    Returns number

    Returns the index of the found element, else -1.

  • see

    _.findLastIndex

    Type parameters

    • T

    Parameters

    Returns number

  • see

    _.findLastIndex

    Type parameters

    • T

    Parameters

    • array: Array<T>
    • pluckValue: string

    Returns number

  • see

    _.findLastIndex

    Type parameters

    • T

    Parameters

    • array: List<T>
    • pluckValue: string

    Returns number

  • see

    _.findLastIndex

    Type parameters

    • T

    Parameters

    • array: Array<T>
    • whereDictionary: Dictionary<any>

    Returns number

  • see

    _.findLastIndex

    Type parameters

    • T

    Parameters

    Returns number

findLastKey

  • findLastKey(object: any, callback: function, thisArg?: any): string
  • findLastKey(object: any, pluckValue: string): string
  • findLastKey<W, T>(object: T, whereValue: W): string
  • This method is like _.findKey except that it iterates over elements of a collection in the opposite order.

    Parameters

    • object: any

      The object to search.

    • callback: function

      The function called per iteration.

        • (value: any): boolean
        • Parameters

          • value: any

          Returns boolean

    • Optional thisArg: any

      The this binding of callback.

    Returns string

    The key of the found element, else undefined.

  • see

    _.findLastKey

    Parameters

    • object: any
    • pluckValue: string

      _.pluck style callback

    Returns string

  • see

    _.findLastKey

    Type parameters

    Parameters

    • object: T
    • whereValue: W

      _.where style callback

    Returns string

findWhere

  • findWhere<T>(collection: Array<T>, callback: ListIterator<T, boolean>, thisArg?: any): T
  • findWhere<T>(collection: List<T>, callback: ListIterator<T, boolean>, thisArg?: any): T
  • findWhere<T>(collection: Dictionary<T>, callback: DictionaryIterator<T, boolean>, thisArg?: any): T
  • findWhere<W, T>(collection: Array<T>, whereValue: W): T
  • findWhere<W, T>(collection: List<T>, whereValue: W): T
  • findWhere<W, T>(collection: Dictionary<T>, whereValue: W): T
  • findWhere<T>(collection: Array<T>, pluckValue: string): T
  • findWhere<T>(collection: List<T>, pluckValue: string): T
  • findWhere<T>(collection: Dictionary<T>, pluckValue: string): T
  • see

    _.find

    Type parameters

    • T

    Parameters

    • collection: Array<T>
    • callback: ListIterator<T, boolean>
    • Optional thisArg: any

    Returns T

  • see

    _.find

    Type parameters

    • T

    Parameters

    Returns T

  • see

    _.find

    Type parameters

    • T

    Parameters

    Returns T

  • see

    _.find

    Type parameters

    • W

    • T

    Parameters

    • collection: Array<T>
    • whereValue: W

    Returns T

  • see

    _.find

    Type parameters

    • W

    • T

    Parameters

    • collection: List<T>
    • whereValue: W

    Returns T

  • see

    _.find

    Type parameters

    • W

    • T

    Parameters

    Returns T

  • see

    _.find

    Type parameters

    • T

    Parameters

    • collection: Array<T>
    • pluckValue: string

    Returns T

  • see

    _.find

    Type parameters

    • T

    Parameters

    • collection: List<T>
    • pluckValue: string

    Returns T

  • see

    _.find

    Type parameters

    • T

    Parameters

    Returns T

first

  • first<T>(array?: Array<T>): T
  • first<T>(array?: List<T>): T
  • first<T>(array: Array<T>, n: number): T[]
  • first<T>(array: List<T>, n: number): T[]
  • first<T>(array: Array<T>, callback: ListIterator<T, boolean>, thisArg?: any): T[]
  • first<T>(array: List<T>, callback: ListIterator<T, boolean>, thisArg?: any): T[]
  • first<T>(array: Array<T>, pluckValue: string): T[]
  • first<T>(array: List<T>, pluckValue: string): T[]
  • first<W, T>(array: Array<T>, whereValue: W): T[]
  • first<W, T>(array: List<T>, whereValue: W): T[]
  • Gets the first element or first n elements of an array. If a callback is provided elements at the beginning of the array are returned as long as the callback returns truey. The callback is bound to thisArg and invoked with three arguments; (value, index, array).

    If a property name is provided for callback the created "_.pluck" style callback will return the property value of the given element.

    If an object is provided for callback the created "_.where" style callback will return ] true for elements that have the properties of the given object, else false.

    Type parameters

    • T

    Parameters

    • Optional array: Array<T>

      Retrieves the first element of this array.

    Returns T

    Returns the first element of array.

  • see

    _.first

    Type parameters

    • T

    Parameters

    • Optional array: List<T>

    Returns T

  • see

    _.first

    Type parameters

    • T

    Parameters

    • array: Array<T>
    • n: number

      The number of elements to return.

    Returns T[]

  • see

    _.first

    Type parameters

    • T

    Parameters

    • array: List<T>
    • n: number

      The number of elements to return.

    Returns T[]

  • see

    _.first

    Type parameters

    • T

    Parameters

    • array: Array<T>
    • callback: ListIterator<T, boolean>

      The function called per element.

    • Optional thisArg: any

    Returns T[]

  • see

    _.first

    Type parameters

    • T

    Parameters

    • array: List<T>
    • callback: ListIterator<T, boolean>

      The function called per element.

    • Optional thisArg: any

    Returns T[]

  • see

    _.first

    Type parameters

    • T

    Parameters

    • array: Array<T>
    • pluckValue: string

      "_.pluck" style callback value

    Returns T[]

  • see

    _.first

    Type parameters

    • T

    Parameters

    • array: List<T>
    • pluckValue: string

      "_.pluck" style callback value

    Returns T[]

  • see

    _.first

    Type parameters

    • W

    • T

    Parameters

    • array: Array<T>
    • whereValue: W

      "_.where" style callback value

    Returns T[]

  • see

    _.first

    Type parameters

    • W

    • T

    Parameters

    • array: List<T>
    • whereValue: W

      "_.where" style callback value

    Returns T[]

flatten

  • Flattens a nested array a single level.

    .flatten(x) is equivalent to .flatten(x, false);

    Type parameters

    • T

    Parameters

    Returns T[]

    array flattened.

  • Flattens a nested array. If isDeep is true the array is recursively flattened, otherwise it is only flattened a single level.

    If you know whether or not this should be recursively at compile time, you typically want to use a version without a boolean parameter (i.e. _.flatten(x) or _.flattenDeep(x)).

    Type parameters

    • T

    Parameters

    Returns List<T> | RecursiveList<T>

    array flattened.

flattenDeep

  • Recursively flattens a nested array.

    .flattenDeep(x) is equivalent to .flatten(x, true);

    Type parameters

    • T

    Parameters

    Returns List<T>

    array recursively flattened

floor

  • floor(n: number, precision?: number): number
  • Calculates n rounded down to precision.

    Parameters

    • n: number

      The number to round down.

    • Optional precision: number

      The precision to round down to.

    Returns number

    Returns the rounded down number.

flow

  • flow<TResult>(...funcs: Function[]): TResult
  • Creates a function that returns the result of invoking the provided functions with the this binding of the created function, where each successive invocation is supplied the return value of the previous.

    Type parameters

    • TResult: Function

    Parameters

    • Rest ...funcs: Function[]

      Functions to invoke.

    Returns TResult

    Returns the new function.

flowRight

  • flowRight<TResult>(...funcs: Function[]): TResult
  • This method is like _.flow except that it creates a function that invokes the provided functions from right to left.

    Type parameters

    • TResult: Function

    Parameters

    • Rest ...funcs: Function[]

      Functions to invoke.

    Returns TResult

    Returns the new function.

foldl

  • foldl<T, TResult>(collection: Array<T>, callback: MemoIterator<T, TResult>, accumulator: TResult, thisArg?: any): TResult
  • foldl<T, TResult>(collection: List<T>, callback: MemoIterator<T, TResult>, accumulator: TResult, thisArg?: any): TResult
  • foldl<T, TResult>(collection: Dictionary<T>, callback: MemoIterator<T, TResult>, accumulator: TResult, thisArg?: any): TResult
  • foldl<T, TResult>(collection: Array<T>, callback: MemoIterator<T, TResult>, thisArg?: any): TResult
  • foldl<T, TResult>(collection: List<T>, callback: MemoIterator<T, TResult>, thisArg?: any): TResult
  • foldl<T, TResult>(collection: Dictionary<T>, callback: MemoIterator<T, TResult>, thisArg?: any): TResult
  • see

    _.reduce

    Type parameters

    • T

    • TResult

    Parameters

    • collection: Array<T>
    • callback: MemoIterator<T, TResult>
    • accumulator: TResult
    • Optional thisArg: any

    Returns TResult

  • see

    _.reduce

    Type parameters

    • T

    • TResult

    Parameters

    • collection: List<T>
    • callback: MemoIterator<T, TResult>
    • accumulator: TResult
    • Optional thisArg: any

    Returns TResult

  • see

    _.reduce

    Type parameters

    • T

    • TResult

    Parameters

    Returns TResult

  • see

    _.reduce

    Type parameters

    • T

    • TResult

    Parameters

    • collection: Array<T>
    • callback: MemoIterator<T, TResult>
    • Optional thisArg: any

    Returns TResult

  • see

    _.reduce

    Type parameters

    • T

    • TResult

    Parameters

    Returns TResult

  • see

    _.reduce

    Type parameters

    • T

    • TResult

    Parameters

    Returns TResult

foldr

  • foldr<T, TResult>(collection: Array<T>, callback: MemoIterator<T, TResult>, accumulator: TResult, thisArg?: any): TResult
  • foldr<T, TResult>(collection: List<T>, callback: MemoIterator<T, TResult>, accumulator: TResult, thisArg?: any): TResult
  • foldr<T, TResult>(collection: Dictionary<T>, callback: MemoIterator<T, TResult>, accumulator: TResult, thisArg?: any): TResult
  • foldr<T, TResult>(collection: Array<T>, callback: MemoIterator<T, TResult>, thisArg?: any): TResult
  • foldr<T, TResult>(collection: List<T>, callback: MemoIterator<T, TResult>, thisArg?: any): TResult
  • foldr<T, TResult>(collection: Dictionary<T>, callback: MemoIterator<T, TResult>, thisArg?: any): TResult
  • see

    _.reduceRight

    Type parameters

    • T

    • TResult

    Parameters

    • collection: Array<T>
    • callback: MemoIterator<T, TResult>
    • accumulator: TResult
    • Optional thisArg: any

    Returns TResult

  • see

    _.reduceRight

    Type parameters

    • T

    • TResult

    Parameters

    • collection: List<T>
    • callback: MemoIterator<T, TResult>
    • accumulator: TResult
    • Optional thisArg: any

    Returns TResult

  • see

    _.reduceRight

    Type parameters

    • T

    • TResult

    Parameters

    Returns TResult

  • see

    _.reduceRight

    Type parameters

    • T

    • TResult

    Parameters

    • collection: Array<T>
    • callback: MemoIterator<T, TResult>
    • Optional thisArg: any

    Returns TResult

  • see

    _.reduceRight

    Type parameters

    • T

    • TResult

    Parameters

    Returns TResult

  • see

    _.reduceRight

    Type parameters

    • T

    • TResult

    Parameters

    Returns TResult

forEach

  • Iterates over elements of a collection, executing the callback for each element. The callback is bound to thisArg and invoked with three arguments; (value, index|key, collection). Callbacks may exit iteration early by explicitly returning false.

    Type parameters

    • T

    Parameters

    • collection: Array<T>

      The collection to iterate over.

    • callback: ListIterator<T, void>

      The function called per iteration.

    • Optional thisArg: any

      The this binding of callback.

    Returns Array<T>

  • see

    _.forEach

    Type parameters

    • T

    Parameters

    Returns List<T>

  • see

    _.forEach

    Type parameters

    • T: object

    Parameters

    Returns Dictionary<T>

  • see

    _.each

    Type parameters

    • T: object

    • TValue

    Parameters

    • object: T
    • callback: ObjectIterator<TValue, void>
    • Optional thisArg: any

    Returns T

forEachRight

  • This method is like _.forEach except that it iterates over elements of a collection from right to left.

    Type parameters

    • T

    Parameters

    • collection: Array<T>

      The collection to iterate over.

    • callback: ListIterator<T, void>

      The function called per iteration.

    • Optional thisArg: any

      The this binding of callback.

    Returns Array<T>

  • see

    _.forEachRight

    Type parameters

    • T

    Parameters

    Returns List<T>

  • see

    _.forEachRight

    Type parameters

    • T: object

    Parameters

    Returns Dictionary<T>

forIn

  • Iterates over own and inherited enumerable properties of an object, executing the callback for each property. The callback is bound to thisArg and invoked with three arguments; (value, key, object). Callbacks may exit iteration early by explicitly returning false.

    Type parameters

    • T

    Parameters

    • object: Dictionary<T>

      The object to iterate over.

    • Optional callback: DictionaryIterator<T, void>

      The function called per iteration.

    • Optional thisArg: any

      The this binding of callback.

    Returns Dictionary<T>

    object

  • see

    _.forIn

    Type parameters

    • T

    Parameters

    • object: T
    • Optional callback: ObjectIterator<any, void>
    • Optional thisArg: any

    Returns T

forInRight

  • This method is like _.forIn except that it iterates over elements of a collection in the opposite order.

    Type parameters

    • T: object

    Parameters

    • object: Dictionary<T>

      The object to iterate over.

    • Optional callback: DictionaryIterator<T, void>

      The function called per iteration.

    • Optional thisArg: any

      The this binding of callback.

    Returns Dictionary<T>

    object

  • see

    _.forInRight

    Type parameters

    • T: object

    Parameters

    • object: T
    • Optional callback: ObjectIterator<T, void>
    • Optional thisArg: any

    Returns T

forOwn

  • Iterates over own enumerable properties of an object, executing the callback for each property. The callback is bound to thisArg and invoked with three arguments; (value, key, object). Callbacks may exit iteration early by explicitly returning false.

    Type parameters

    • T: object

    Parameters

    • object: Dictionary<T>

      The object to iterate over.

    • Optional callback: DictionaryIterator<T, void>

      The function called per iteration.

    • Optional thisArg: any

      The this binding of callback.

    Returns Dictionary<T>

    object

  • see

    _.forOwn

    Type parameters

    • T: object

    Parameters

    • object: T
    • Optional callback: ObjectIterator<any, void>
    • Optional thisArg: any

    Returns T

forOwnRight

  • This method is like _.forOwn except that it iterates over elements of a collection in the opposite order.

    Type parameters

    • T: object

    Parameters

    • object: Dictionary<T>

      The object to iterate over.

    • Optional callback: DictionaryIterator<T, void>

      The function called per iteration.

    • Optional thisArg: any

      The this binding of callback.

    Returns Dictionary<T>

    object

  • see

    _.forOwnRight

    Type parameters

    • T: object

    Parameters

    • object: T
    • Optional callback: ObjectIterator<any, void>
    • Optional thisArg: any

    Returns T

functions

  • functions(object: any): string[]
  • Creates a sorted array of property names of all enumerable properties, own and inherited, of object that have function values.

    Parameters

    • object: any

      The object to inspect.

    Returns string[]

    An array of property names that have function values.

get

  • get<T>(object: Object, path: string | string[], defaultValue?: T): T
  • Gets the property value at path of object. If the resolved value is undefined the defaultValue is used in its place.

    Type parameters

    • T

    Parameters

    • object: Object

      The object to query.

    • path: string | string[]

      The path of the property to get.

    • Optional defaultValue: T

      The value returned if the resolved value is undefined.

    Returns T

    Returns the resolved value.

groupBy

  • Creates an object composed of keys generated from the results of running each element of a collection through the callback. The corresponding value of each key is an array of the elements responsible for generating the key. The callback is bound to thisArg and invoked with three arguments; (value, index|key, collection).

    If a property name is provided for callback the created ".pluck" style callback will return the property value of the given element. If an object is provided for callback the created ".where" style callback will return true for elements that have the properties of the given object, else false

    Type parameters

    • T

    Parameters

    • collection: Array<T>

      The collection to iterate over.

    • Optional callback: ListIterator<T, any>

      The function called per iteration.

    • Optional thisArg: any

      The this binding of callback.

    Returns Dictionary<T[]>

    Returns the composed aggregate object.

  • see

    _.groupBy

    Type parameters

    • T

    Parameters

    • collection: List<T>
    • Optional callback: ListIterator<T, any>
    • Optional thisArg: any

    Returns Dictionary<T[]>

  • see

    _.groupBy

    Type parameters

    • T

    Parameters

    • collection: Array<T>
    • pluckValue: string

      _.pluck style callback

    Returns Dictionary<T[]>

  • see

    _.groupBy

    Type parameters

    • T

    Parameters

    • collection: List<T>
    • pluckValue: string

      _.pluck style callback

    Returns Dictionary<T[]>

  • see

    _.groupBy

    Type parameters

    • W

    • T

    Parameters

    • collection: Array<T>
    • whereValue: W

      _.where style callback

    Returns Dictionary<T[]>

  • see

    _.groupBy

    Type parameters

    • W

    • T

    Parameters

    • collection: List<T>
    • whereValue: W

      _.where style callback

    Returns Dictionary<T[]>

  • see

    _.groupBy

    Type parameters

    • T

    Parameters

    Returns Dictionary<T[]>

  • see

    _.groupBy

    Type parameters

    • TValue

    Parameters

    • collection: Dictionary<TValue>
    • pluckValue: string

      _.pluck style callback

    Returns Dictionary<TValue[]>

  • see

    _.groupBy

    Type parameters

    • W

    • TValue

    Parameters

    • collection: Dictionary<TValue>
    • whereValue: W

      _.where style callback

    Returns Dictionary<TValue[]>

gt

  • gt(value: any, other: any): boolean
  • Checks if value is greater than other.

    Parameters

    • value: any

      The value to compare.

    • other: any

      The other value to compare.

    Returns boolean

    Returns true if value is greater than other, else false.

gte

  • gte(value: any, other: any): boolean
  • Checks if value is greater than or equal to other.

    Parameters

    • value: any

      The value to compare.

    • other: any

      The other value to compare.

    Returns boolean

    Returns true if value is greater than or equal to other, else false.

has

  • has(object: any, path: string | string[]): boolean
  • Checks if path is a direct property.

    Parameters

    • object: any

      The object to query.

    • path: string | string[]

      The path to check.

    Returns boolean

    True if path is a direct property, else False.

head

  • head<T>(array: Array<T>): T
  • head<T>(array: List<T>): T
  • head<T>(array: Array<T>, n: number): T[]
  • head<T>(array: List<T>, n: number): T[]
  • head<T>(array: Array<T>, callback: ListIterator<T, boolean>, thisArg?: any): T[]
  • head<T>(array: List<T>, callback: ListIterator<T, boolean>, thisArg?: any): T[]
  • head<T>(array: Array<T>, pluckValue: string): T[]
  • head<T>(array: List<T>, pluckValue: string): T[]
  • head<W, T>(array: Array<T>, whereValue: W): T[]
  • head<W, T>(array: List<T>, whereValue: W): T[]
  • see

    _.first

    Type parameters

    • T

    Parameters

    • array: Array<T>

    Returns T

  • see

    _.first

    Type parameters

    • T

    Parameters

    Returns T

  • see

    _.first

    Type parameters

    • T

    Parameters

    • array: Array<T>
    • n: number

    Returns T[]

  • see

    _.first

    Type parameters

    • T

    Parameters

    • array: List<T>
    • n: number

    Returns T[]

  • see

    _.first

    Type parameters

    • T

    Parameters

    • array: Array<T>
    • callback: ListIterator<T, boolean>
    • Optional thisArg: any

    Returns T[]

  • see

    _.first

    Type parameters

    • T

    Parameters

    Returns T[]

  • see

    _.first

    Type parameters

    • T

    Parameters

    • array: Array<T>
    • pluckValue: string

    Returns T[]

  • see

    _.first

    Type parameters

    • T

    Parameters

    • array: List<T>
    • pluckValue: string

    Returns T[]

  • see

    _.first

    Type parameters

    • W

    • T

    Parameters

    • array: Array<T>
    • whereValue: W

    Returns T[]

  • see

    _.first

    Type parameters

    • W

    • T

    Parameters

    • array: List<T>
    • whereValue: W

    Returns T[]

identity

  • identity<T>(value?: T): T
  • This method returns the first argument provided to it.

    Type parameters

    • T

    Parameters

    • Optional value: T

      Any value.

    Returns T

    Returns value.

inRange

  • inRange(n: number, start: number, end: number): boolean
  • inRange(n: number, end: number): boolean
  • Checks if n is between start and up to but not including, end. If end is not specified it’s set to start with start then set to 0.

    Parameters

    • n: number

      The number to check.

    • start: number

      The start of the range.

    • end: number

      The end of the range.

    Returns boolean

    Returns true if n is in the range, else false.

  • see

    _.inRange

    Parameters

    • n: number
    • end: number

    Returns boolean

include

  • include<T>(collection: Array<T>, target: T, fromIndex?: number): boolean
  • include<T>(collection: List<T>, target: T, fromIndex?: number): boolean
  • include<T>(dictionary: Dictionary<T>, value: T, fromIndex?: number): boolean
  • include(searchString: string, targetString: string, fromIndex?: number): boolean
  • see

    _.contains

    Type parameters

    • T

    Parameters

    • collection: Array<T>
    • target: T
    • Optional fromIndex: number

    Returns boolean

  • see

    _.contains

    Type parameters

    • T

    Parameters

    • collection: List<T>
    • target: T
    • Optional fromIndex: number

    Returns boolean

  • see

    _.contains

    Type parameters

    • T

    Parameters

    • dictionary: Dictionary<T>
    • value: T
    • Optional fromIndex: number

    Returns boolean

  • see

    _.contains

    Parameters

    • searchString: string
    • targetString: string
    • Optional fromIndex: number

    Returns boolean

includes

  • includes<T>(collection: Array<T>, target: T, fromIndex?: number): boolean
  • includes<T>(collection: List<T>, target: T, fromIndex?: number): boolean
  • includes<T>(dictionary: Dictionary<T>, value: T, fromIndex?: number): boolean
  • includes(searchString: string, targetString: string, fromIndex?: number): boolean
  • see

    _.contains

    Type parameters

    • T

    Parameters

    • collection: Array<T>
    • target: T
    • Optional fromIndex: number

    Returns boolean

  • see

    _.contains

    Type parameters

    • T

    Parameters

    • collection: List<T>
    • target: T
    • Optional fromIndex: number

    Returns boolean

  • see

    _.contains

    Type parameters

    • T

    Parameters

    • dictionary: Dictionary<T>
    • value: T
    • Optional fromIndex: number

    Returns boolean

  • see

    _.contains

    Parameters

    • searchString: string
    • targetString: string
    • Optional fromIndex: number

    Returns boolean

indexBy

  • Creates an object composed of keys generated from the results of running each element of the collection through the given callback. The corresponding value of each key is the last element responsible for generating the key. The callback is bound to thisArg and invoked with three arguments; (value, index|key, collection).

    If a property name is provided for callback the created "_.pluck" style callback will return the property value of the given element.

    If an object is provided for callback the created "_.where" style callback will return true for elements that have the properties of the given object, else false.

    Type parameters

    • T

    Parameters

    • list: Array<T>
    • iterator: ListIterator<T, any>
    • Optional context: any

    Returns Dictionary<T>

    Returns the composed aggregate object.

  • see

    _.indexBy

    Type parameters

    • T

    Parameters

    Returns Dictionary<T>

  • see

    _.indexBy

    Type parameters

    • T

    Parameters

    • collection: Array<T>
    • pluckValue: string

      _.pluck style callback

    Returns Dictionary<T>

  • see

    _.indexBy

    Type parameters

    • T

    Parameters

    • collection: List<T>
    • pluckValue: string

      _.pluck style callback

    Returns Dictionary<T>

  • see

    _.indexBy

    Type parameters

    • W

    • T

    Parameters

    • collection: Array<T>
    • whereValue: W

      _.where style callback

    Returns Dictionary<T>

  • see

    _.indexBy

    Type parameters

    • W

    • T

    Parameters

    • collection: List<T>
    • whereValue: W

      _.where style callback

    Returns Dictionary<T>

indexOf

  • indexOf<T>(array: Array<T>, value: T): number
  • indexOf<T>(array: List<T>, value: T): number
  • indexOf<T>(array: Array<T>, value: T, fromIndex: number): number
  • indexOf<T>(array: List<T>, value: T, fromIndex: number): number
  • indexOf<T>(array: Array<T>, value: T, isSorted: boolean): number
  • indexOf<T>(array: List<T>, value: T, isSorted: boolean): number
  • Gets the index at which the first occurrence of value is found using strict equality for comparisons, i.e. ===. If the array is already sorted providing true for fromIndex will run a faster binary search.

    Type parameters

    • T

    Parameters

    • array: Array<T>

      The array to search.

    • value: T

      The value to search for.

    Returns number

    The index of value within array.

  • see

    _.indexOf

    Type parameters

    • T

    Parameters

    • array: List<T>
    • value: T

    Returns number

  • see

    _.indexOf

    Type parameters

    • T

    Parameters

    • array: Array<T>
    • value: T
    • fromIndex: number

      The index to search from

    Returns number

  • see

    _.indexOf

    Type parameters

    • T

    Parameters

    • array: List<T>
    • value: T
    • fromIndex: number

      The index to search from

    Returns number

  • see

    _.indexOf

    Type parameters

    • T

    Parameters

    • array: Array<T>
    • value: T
    • isSorted: boolean

      True to perform a binary search on a sorted array.

    Returns number

  • see

    _.indexOf

    Type parameters

    • T

    Parameters

    • array: List<T>
    • value: T
    • isSorted: boolean

      True to perform a binary search on a sorted array.

    Returns number

initial

  • initial<T>(array: Array<T>): T[]
  • initial<T>(array: List<T>): T[]
  • initial<T>(array: Array<T>, n: number): T[]
  • initial<T>(array: List<T>, n: number): T[]
  • initial<T>(array: Array<T>, callback: ListIterator<T, boolean>): T[]
  • initial<T>(array: List<T>, callback: ListIterator<T, boolean>): T[]
  • initial<T>(array: Array<T>, pluckValue: string): T[]
  • initial<T>(array: List<T>, pluckValue: string): T[]
  • initial<W, T>(array: Array<T>, whereValue: W): T[]
  • initial<W, T>(array: List<T>, whereValue: W): T[]
  • Gets all but the last element or last n elements of an array. If a callback is provided elements at the end of the array are excluded from the result as long as the callback returns truey. The callback is bound to thisArg and invoked with three arguments; (value, index, array).

    If a property name is provided for callback the created "_.pluck" style callback will return the property value of the given element.

    If an object is provided for callback the created "_.where" style callback will return true for elements that have the properties of the given object, else false.

    Type parameters

    • T

    Parameters

    • array: Array<T>

      The array to query.

    Returns T[]

    Returns everything but the last n elements of array.

  • see

    _.initial

    Type parameters

    • T

    Parameters

    Returns T[]

  • see

    _.initial

    Type parameters

    • T

    Parameters

    • array: Array<T>
    • n: number

      The number of elements to exclude.

    Returns T[]

  • see

    _.initial

    Type parameters

    • T

    Parameters

    • array: List<T>
    • n: number

      The number of elements to exclude.

    Returns T[]

  • see

    _.initial

    Type parameters

    • T

    Parameters

    • array: Array<T>
    • callback: ListIterator<T, boolean>

      The function called per element

    Returns T[]

  • see

    _.initial

    Type parameters

    • T

    Parameters

    • array: List<T>
    • callback: ListIterator<T, boolean>

      The function called per element

    Returns T[]

  • see

    _.initial

    Type parameters

    • T

    Parameters

    • array: Array<T>
    • pluckValue: string

      _.pluck style callback

    Returns T[]

  • see

    _.initial

    Type parameters

    • T

    Parameters

    • array: List<T>
    • pluckValue: string

      _.pluck style callback

    Returns T[]

  • see

    _.initial

    Type parameters

    • W

    • T

    Parameters

    • array: Array<T>
    • whereValue: W

      _.where style callback

    Returns T[]

  • see

    _.initial

    Type parameters

    • W

    • T

    Parameters

    • array: List<T>
    • whereValue: W

      _.where style callback

    Returns T[]

inject

  • inject<T, TResult>(collection: Array<T>, callback: MemoIterator<T, TResult>, accumulator: TResult, thisArg?: any): TResult
  • inject<T, TResult>(collection: List<T>, callback: MemoIterator<T, TResult>, accumulator: TResult, thisArg?: any): TResult
  • inject<T, TResult>(collection: Dictionary<T>, callback: MemoIterator<T, TResult>, accumulator: TResult, thisArg?: any): TResult
  • inject<T, TResult>(collection: Array<T>, callback: MemoIterator<T, TResult>, thisArg?: any): TResult
  • inject<T, TResult>(collection: List<T>, callback: MemoIterator<T, TResult>, thisArg?: any): TResult
  • inject<T, TResult>(collection: Dictionary<T>, callback: MemoIterator<T, TResult>, thisArg?: any): TResult
  • see

    _.reduce

    Type parameters

    • T

    • TResult

    Parameters

    • collection: Array<T>
    • callback: MemoIterator<T, TResult>
    • accumulator: TResult
    • Optional thisArg: any

    Returns TResult

  • see

    _.reduce

    Type parameters

    • T

    • TResult

    Parameters

    • collection: List<T>
    • callback: MemoIterator<T, TResult>
    • accumulator: TResult
    • Optional thisArg: any

    Returns TResult

  • see

    _.reduce

    Type parameters

    • T

    • TResult

    Parameters

    Returns TResult

  • see

    _.reduce

    Type parameters

    • T

    • TResult

    Parameters

    • collection: Array<T>
    • callback: MemoIterator<T, TResult>
    • Optional thisArg: any

    Returns TResult

  • see

    _.reduce

    Type parameters

    • T

    • TResult

    Parameters

    Returns TResult

  • see

    _.reduce

    Type parameters

    • T

    • TResult

    Parameters

    Returns TResult

intersection

  • intersection<T>(...arrays: Array<T>[]): T[]
  • intersection<T>(...arrays: List<T>[]): T[]
  • Creates an array of unique values present in all provided arrays using strict equality for comparisons, i.e. ===.

    Type parameters

    • T

    Parameters

    • Rest ...arrays: Array<T>[]

      The arrays to inspect.

    Returns T[]

    Returns an array of composite values.

  • see

    _.intersection

    Type parameters

    • T

    Parameters

    • Rest ...arrays: List<T>[]

    Returns T[]

invert

  • invert(object: any): any
  • Creates an object composed of the inverted keys and values of the given object.

    Parameters

    • object: any

      The object to invert.

    Returns any

    The created inverted object.

invoke

  • invoke<T>(collection: Array<T>, methodName: string, ...args: any[]): any
  • invoke<T>(collection: List<T>, methodName: string, ...args: any[]): any
  • invoke<T>(collection: Dictionary<T>, methodName: string, ...args: any[]): any
  • invoke<T>(collection: Array<T>, method: Function, ...args: any[]): any
  • invoke<T>(collection: List<T>, method: Function, ...args: any[]): any
  • invoke<T>(collection: Dictionary<T>, method: Function, ...args: any[]): any
  • Invokes the method named by methodName on each element in the collection returning an array of the results of each invoked method. Additional arguments will be provided to each invoked method. If methodName is a function it will be invoked for, and this bound to, each element in the collection.

    Type parameters

    • T: object

    Parameters

    • collection: Array<T>

      The collection to iterate over.

    • methodName: string

      The name of the method to invoke.

    • Rest ...args: any[]

      Arguments to invoke the method with.

    Returns any

  • see

    _.invoke

    Type parameters

    • T: object

    Parameters

    • collection: List<T>
    • methodName: string
    • Rest ...args: any[]

    Returns any

  • see

    _.invoke

    Type parameters

    • T: object

    Parameters

    • collection: Dictionary<T>
    • methodName: string
    • Rest ...args: any[]

    Returns any

  • see

    _.invoke

    Type parameters

    • T: object

    Parameters

    • collection: Array<T>
    • method: Function
    • Rest ...args: any[]

    Returns any

  • see

    _.invoke

    Type parameters

    • T: object

    Parameters

    • collection: List<T>
    • method: Function
    • Rest ...args: any[]

    Returns any

  • see

    _.invoke

    Type parameters

    • T: object

    Parameters

    • collection: Dictionary<T>
    • method: Function
    • Rest ...args: any[]

    Returns any

isArguments

  • isArguments(value?: any): boolean
  • Checks if value is classified as an arguments object.

    Parameters

    • Optional value: any

      The value to check.

    Returns boolean

    Returns true if value is correctly classified, else false.

isArray

  • isArray(value?: any): boolean
  • Checks if value is classified as an Array object.

    Parameters

    • Optional value: any

      The value to check.

    Returns boolean

    Returns true if value is correctly classified, else false.

isBoolean

  • isBoolean(value?: any): boolean
  • Checks if value is classified as a boolean primitive or object.

    Parameters

    • Optional value: any

      The value to check.

    Returns boolean

    Returns true if value is correctly classified, else false.

isDate

  • isDate(value?: any): boolean
  • Checks if value is classified as a Date object.

    Parameters

    • Optional value: any

      The value to check.

    Returns boolean

    Returns true if value is correctly classified, else false.

isElement

  • isElement(value?: any): boolean
  • Checks if value is a DOM element.

    Parameters

    • Optional value: any

      The value to check.

    Returns boolean

    Returns true if value is a DOM element, else false.

isEmpty

  • isEmpty(value?: any[] | Dictionary<any> | string | any): boolean
  • Checks if value is empty. A value is considered empty unless it’s an arguments object, array, string, or jQuery-like collection with a length greater than 0 or an object with own enumerable properties.

    Parameters

    • Optional value: any[] | Dictionary<any> | string | any

      The value to inspect.

    Returns boolean

    Returns true if value is empty, else false.

isEqual

  • isEqual(value?: any, other?: any, callback?: EqCustomizer, thisArg?: any): boolean
  • Performs a deep comparison between two values to determine if they are equivalent. If customizer is provided it is invoked to compare values. If customizer returns undefined comparisons are handled by the method instead. The customizer is bound to thisArg and invoked with three arguments: (value, other [, index|key]).

    Parameters

    • Optional value: any

      The value to compare.

    • Optional other: any

      The other value to compare.

    • Optional callback: EqCustomizer

      The function to customize value comparisons.

    • Optional thisArg: any

      The this binding of customizer.

    Returns boolean

    True if the values are equivalent, else false.

isError

  • isError(value: any): boolean
  • Checks if value is an Error, EvalError, RangeError, ReferenceError, SyntaxError, TypeError, or URIError object.

    Parameters

    • value: any

      The value to check.

    Returns boolean

    Returns true if value is an error object, else false.

isFinite

  • isFinite(value?: any): boolean
  • Checks if value is a finite primitive number. Note: This method is based on Number.isFinite.

    Parameters

    • Optional value: any

      The value to check.

    Returns boolean

    Returns true if value is a finite number, else false.

isFunction

  • isFunction(value?: any): boolean
  • Checks if value is classified as a Function object.

    Parameters

    • Optional value: any

      The value to check.

    Returns boolean

    Returns true if value is correctly classified, else false.

isMatch

  • isMatch(object: Object, source: Object, customizer?: isMatchCustomizer, thisArg?: any): boolean
  • Performs a deep comparison between object and source to determine if object contains equivalent property values. If customizer is provided it’s invoked to compare values. If customizer returns undefined comparisons are handled by the method instead. The customizer is bound to thisArg and invoked with three arguments: (value, other, index|key).

    Parameters

    • object: Object

      The object to inspect.

    • source: Object

      The object of property values to match.

    • Optional customizer: isMatchCustomizer

      The function to customize value comparisons.

    • Optional thisArg: any

      The this binding of customizer.

    Returns boolean

    Returns true if object is a match, else false.

isNaN

  • isNaN(value?: any): boolean
  • Checks if value is NaN. Note: This method is not the same as isNaN which returns true for undefined and other non-numeric values.

    Parameters

    • Optional value: any

      The value to check.

    Returns boolean

    Returns true if value is NaN, else false.

isNative

  • isNative(value: any): boolean
  • Checks if value is a native function.

    retrun

    Returns true if value is a native function, else false.

    Parameters

    • value: any

      The value to check.

    Returns boolean

isNull

  • isNull(value?: any): boolean
  • Checks if value is null.

    Parameters

    • Optional value: any

      The value to check.

    Returns boolean

    Returns true if value is null, else false.

isNumber

  • isNumber(value?: any): boolean
  • Checks if value is classified as a Number primitive or object. Note: To exclude Infinity, -Infinity, and NaN, which are classified as numbers, use the _.isFinite method.

    Parameters

    • Optional value: any

      The value to check.

    Returns boolean

    Returns true if value is correctly classified, else false.

isObject

  • isObject(value?: any): boolean
  • Checks if value is the language type of Object. (e.g. arrays, functions, objects, regexes, new Number(0), and new String(''))

    Parameters

    • Optional value: any

      The value to check.

    Returns boolean

    Returns true if value is an object, else false.

isPlainObject

  • isPlainObject(value?: any): boolean
  • Checks if value is a plain object, that is, an object created by the Object constructor or one with a Prototype of null.

    Note: This method assumes objects created by the Object constructor have no inherited enumerable properties.

    Parameters

    • Optional value: any

      The value to check.

    Returns boolean

    Returns true if value is a plain object, else false.

isRegExp

  • isRegExp(value?: any): boolean
  • Checks if value is classified as a RegExp object.

    Parameters

    • Optional value: any

      The value to check.

    Returns boolean

    Returns true if value is correctly classified, else false.

isString

  • isString(value?: any): boolean
  • Checks if value is classified as a String primitive or object.

    Parameters

    • Optional value: any

      The value to check.

    Returns boolean

    Returns true if value is correctly classified, else false.

isTypedArray

  • isTypedArray(value: any): boolean
  • Checks if value is classified as a typed array.

    Parameters

    • value: any

      The value to check.

    Returns boolean

    Returns true if value is correctly classified, else false.

isUndefined

  • isUndefined(value: any): boolean
  • Checks if value is undefined.

    Parameters

    • value: any

      The value to check.

    Returns boolean

    Returns true if value is undefined, else false.

kebabCase

  • kebabCase(string?: string): string
  • Converts string to kebab case.

    Parameters

    • Optional string: string

      The string to convert.

    Returns string

    Returns the kebab cased string.

keys

  • keys(object?: any): string[]
  • Creates an array composed of the own enumerable property names of an object.

    Parameters

    • Optional object: any

      The object to inspect.

    Returns string[]

    An array of property names.

keysIn

  • keysIn(object?: any): string[]
  • Creates an array of the own and inherited enumerable property names of object.

    Parameters

    • Optional object: any

      The object to query.

    Returns string[]

    An array of property names.

last

  • last<T>(array: Array<T>): T
  • Gets the last element of an array.

    Type parameters

    • T

    Parameters

    • array: Array<T>

      The array to query.

    Returns T

    Returns the last element of array.

lastIndexOf

  • lastIndexOf<T>(array: Array<T>, value: T, fromIndex?: number): number
  • lastIndexOf<T>(array: List<T>, value: T, fromIndex?: number): number
  • Gets the index at which the last occurrence of value is found using strict equality for comparisons, i.e. ===. If fromIndex is negative, it is used as the offset from the end of the collection.

    Type parameters

    • T

    Parameters

    • array: Array<T>

      The array to search.

    • value: T

      The value to search for.

    • Optional fromIndex: number

      The index to search from.

    Returns number

    The index of the matched value or -1.

  • see

    _.lastIndexOf

    Type parameters

    • T

    Parameters

    • array: List<T>
    • value: T
    • Optional fromIndex: number

    Returns number

lt

  • lt(value: any, other: any): boolean
  • Checks if value is less than other.

    Parameters

    • value: any

      The value to compare.

    • other: any

      The other value to compare.

    Returns boolean

    Returns true if value is less than other, else false.

lte

  • lte(value: any, other: any): boolean
  • Checks if value is less than or equal to other.

    Parameters

    • value: any

      The value to compare.

    • other: any

      The other value to compare.

    Returns boolean

    Returns true if value is less than or equal to other, else false.

map

  • map<T, TResult>(collection: Array<T>, callback: ListIterator<T, TResult>, thisArg?: any): TResult[]
  • map<T, TResult>(collection: List<T>, callback: ListIterator<T, TResult>, thisArg?: any): TResult[]
  • map<T, TResult>(object: Dictionary<T>, callback: DictionaryIterator<T, TResult>, thisArg?: any): TResult[]
  • map<T, TResult>(collection: Array<T>, pluckValue: string): TResult[]
  • map<T, TResult>(collection: List<T>, pluckValue: string): TResult[]
  • Creates an array of values by running each element in the collection through the callback. The callback is bound to thisArg and invoked with three arguments; (value, index|key, collection).

    If a property name is provided for callback the created "_.pluck" style callback will return the property value of the given element.

    If an object is provided for callback the created "_.where" style callback will return true for elements that have the properties of the given object, else false.

    Type parameters

    • T

    • TResult

    Parameters

    • collection: Array<T>

      The collection to iterate over.

    • callback: ListIterator<T, TResult>

      The function called per iteration.

    • Optional thisArg: any

    Returns TResult[]

    The mapped array result.

  • see

    _.map

    Type parameters

    • T

    • TResult

    Parameters

    Returns TResult[]

  • see

    _.map

    Type parameters

    • T: object

    • TResult

    Parameters

    • object: Dictionary<T>

      The object to iterate over.

    • callback: DictionaryIterator<T, TResult>

      The function called per iteration.

    • Optional thisArg: any

      this object in iterator, optional.

    Returns TResult[]

    The mapped object result.

  • see

    _.map

    Type parameters

    • T

    • TResult

    Parameters

    • collection: Array<T>
    • pluckValue: string

      _.pluck style callback

    Returns TResult[]

  • see

    _.map

    Type parameters

    • T

    • TResult

    Parameters

    • collection: List<T>
    • pluckValue: string

      _.pluck style callback

    Returns TResult[]

mapValues

  • Creates an object with the same keys as object and values generated by running each own enumerable property of object through iteratee. The iteratee function is bound to thisArg and invoked with three arguments: (value, key, object).

    If a property name is provided iteratee the created "_.property" style callback returns the property value of the given element.

    If a value is also provided for thisArg the creted "_.matchesProperty" style callback returns true for elements that have a matching property value, else false;.

    If an object is provided for iteratee the created "_.matches" style callback returns true for elements that have the properties of the given object, else false.

    Type parameters

    • T

    • TResult

    Parameters

    Returns Dictionary<TResult>

    Returns the new mapped object.

  • Type parameters

    • T

    Parameters

    Returns Dictionary<boolean>

  • Type parameters

    • T

    • TMapped

    Parameters

    • obj: T
    • pluck: string

    Returns TMapped

  • Type parameters

    • T

    Parameters

    Returns T

max

  • max<T>(collection: Array<T>, callback?: ListIterator<T, any>, thisArg?: any): T
  • max<T>(collection: List<T>, callback?: ListIterator<T, any>, thisArg?: any): T
  • max<T>(collection: Dictionary<T>, callback?: DictionaryIterator<T, any>, thisArg?: any): T
  • max<T>(collection: Array<T>, pluckValue: string): T
  • max<T>(collection: List<T>, pluckValue: string): T
  • max<T>(collection: Dictionary<T>, pluckValue: string): T
  • max<W, T>(collection: Array<T>, whereValue: W): T
  • max<W, T>(collection: List<T>, whereValue: W): T
  • max<W, T>(collection: Dictionary<T>, whereValue: W): T
  • Retrieves the maximum value of a collection. If the collection is empty or falsey -Infinity is returned. If a callback is provided it will be executed for each value in the collection to generate the criterion by which the value is ranked. The callback is bound to thisArg and invoked with three arguments; (value, index, collection).

    If a property name is provided for callback the created "_.pluck" style callback will return the property value of the given element.

    If an object is provided for callback the created "_.where" style callback will return true for elements that have the properties of the given object, else false.

    Type parameters

    • T

    Parameters

    • collection: Array<T>

      The collection to iterate over.

    • Optional callback: ListIterator<T, any>

      The function called per iteration.

    • Optional thisArg: any

      The this binding of callback.

    Returns T

    Returns the maximum value.

  • see

    _.max

    Type parameters

    • T

    Parameters

    • collection: List<T>
    • Optional callback: ListIterator<T, any>
    • Optional thisArg: any

    Returns T

  • see

    _.max

    Type parameters

    • T

    Parameters

    Returns T

  • see

    _.max

    Type parameters

    • T

    Parameters

    • collection: Array<T>
    • pluckValue: string

      _.pluck style callback

    Returns T

  • see

    _.max

    Type parameters

    • T

    Parameters

    • collection: List<T>
    • pluckValue: string

      _.pluck style callback

    Returns T

  • see

    _.max

    Type parameters

    • T

    Parameters

    • collection: Dictionary<T>
    • pluckValue: string

      _.pluck style callback

    Returns T

  • see

    _.max

    Type parameters

    • W

    • T

    Parameters

    • collection: Array<T>
    • whereValue: W

      _.where style callback

    Returns T

  • see

    _.max

    Type parameters

    • W

    • T

    Parameters

    • collection: List<T>
    • whereValue: W

      _.where style callback

    Returns T

  • see

    _.max

    Type parameters

    • W

    • T

    Parameters

    • collection: Dictionary<T>
    • whereValue: W

      _.where style callback

    Returns T

memoize

  • memoize<TResult>(func: Function, resolver?: Function): TResult
  • Creates a function that memoizes the result of func. If resolver is provided it determines the cache key for storing the result based on the arguments provided to the memoized function. By default, the first argument provided to the memoized function is coerced to a string and used as the cache key. The func is invoked with the this binding of the memoized function.

    Type parameters

    Parameters

    • func: Function

      The function to have its output memoized.

    • Optional resolver: Function

      The function to resolve the cache key.

    Returns TResult

    Returns the new memoizing function.

merge

  • merge<P, T, S1, Value, Result>(object: T, s1: S1, callback?: function, thisArg?: any): Result
  • merge<P, T, S1, S2, Value, Result>(object: T, s1: S1, s2: S2, callback?: function, thisArg?: any): Result
  • merge<P, T, S1, S2, S3, Value, Result>(object: T, s1: S1, s2: S2, s3: S3, callback?: function, thisArg?: any): Result
  • merge<P, T, S1, S2, S3, S4, Value, Result>(object: T, s1: S1, s2: S2, s3: S3, s4: S4, callback?: function, thisArg?: any): Result
  • Recursively merges own enumerable properties of the source object(s), that don't resolve to undefined into the destination object. Subsequent sources will overwrite property assignments of previous sources. If a callback is provided it will be executed to produce the merged values of the destination and source properties. If the callback returns undefined merging will be handled by the method instead. The callback is bound to thisArg and invoked with two arguments; (objectValue, sourceValue).

    Type parameters

    • P

    • T

    • S1

    • Value

    • Result

    Parameters

    • object: T

      The destination object.

    • s1: S1
    • Optional callback: function

      The function to customize merging properties.

        • (objectValue: Value, sourceValue: Value): Value
        • Parameters

          • objectValue: Value
          • sourceValue: Value

          Returns Value

    • Optional thisArg: any

      The this binding of callback.

    Returns Result

    The destination object.

  • see

    _.merge

    Type parameters

    • P

    • T

    • S1

    • S2

    • Value

    • Result

    Parameters

    • object: T
    • s1: S1
    • s2: S2
    • Optional callback: function
        • (objectValue: Value, sourceValue: Value): Value
        • Parameters

          • objectValue: Value
          • sourceValue: Value

          Returns Value

    • Optional thisArg: any

    Returns Result

  • see

    _.merge

    Type parameters

    • P

    • T

    • S1

    • S2

    • S3

    • Value

    • Result

    Parameters

    • object: T
    • s1: S1
    • s2: S2
    • s3: S3
    • Optional callback: function
        • (objectValue: Value, sourceValue: Value): Value
        • Parameters

          • objectValue: Value
          • sourceValue: Value

          Returns Value

    • Optional thisArg: any

    Returns Result

  • see

    _.merge

    Type parameters

    • P

    • T

    • S1

    • S2

    • S3

    • S4

    • Value

    • Result

    Parameters

    • object: T
    • s1: S1
    • s2: S2
    • s3: S3
    • s4: S4
    • Optional callback: function
        • (objectValue: Value, sourceValue: Value): Value
        • Parameters

          • objectValue: Value
          • sourceValue: Value

          Returns Value

    • Optional thisArg: any

    Returns Result

method

  • method<TResult>(path: string, ...args: any[]): function
  • method<TResult>(path: any[], ...args: any[]): function
  • Creates a function that invokes the method at path on a given object. Any additional arguments are provided to the invoked method.

    Type parameters

    • TResult

    Parameters

    • path: string

      The path of the method to invoke.

    • Rest ...args: any[]

      The arguments to invoke the method with.

    Returns function

    Returns the new function.

      • (object: any): TResult
      • Parameters

        • object: any

        Returns TResult

  • see

    _.method

    Type parameters

    • TResult

    Parameters

    • path: any[]
    • Rest ...args: any[]

    Returns function

      • (object: any): TResult
      • Parameters

        • object: any

        Returns TResult

methodOf

  • methodOf<TResult>(object: Object, ...args: any[]): function
  • The opposite of _.method; this method creates a function that invokes the method at a given path on object. Any additional arguments are provided to the invoked method.

    Type parameters

    • TResult

    Parameters

    • object: Object

      The object to query.

    • Rest ...args: any[]

      The arguments to invoke the method with.

    Returns function

    Returns the new function.

      • (path: string | any[]): TResult
      • Parameters

        • path: string | any[]

        Returns TResult

methods

  • methods(object: any): string[]
  • see

    _functions

    Parameters

    • object: any

    Returns string[]

min

  • min<T>(collection: Array<T>, callback?: ListIterator<T, any>, thisArg?: any): T
  • min<T>(collection: List<T>, callback?: ListIterator<T, any>, thisArg?: any): T
  • min<T>(collection: Dictionary<T>, callback?: ListIterator<T, any>, thisArg?: any): T
  • min<T>(collection: Array<T>, pluckValue: string): T
  • min<T>(collection: List<T>, pluckValue: string): T
  • min<T>(collection: Dictionary<T>, pluckValue: string): T
  • min<W, T>(collection: Array<T>, whereValue: W): T
  • min<W, T>(collection: List<T>, whereValue: W): T
  • min<W, T>(collection: Dictionary<T>, whereValue: W): T
  • Retrieves the minimum value of a collection. If the collection is empty or falsey Infinity is returned. If a callback is provided it will be executed for each value in the collection to generate the criterion by which the value is ranked. The callback is bound to thisArg and invoked with three arguments; (value, index, collection).

    If a property name is provided for callback the created "_.pluck" style callback will return the property value of the given element.

    If an object is provided for callback the created "_.where" style callback will return true for elements that have the properties of the given object, else false.

    Type parameters

    • T

    Parameters

    • collection: Array<T>

      The collection to iterate over.

    • Optional callback: ListIterator<T, any>

      The function called per iteration.

    • Optional thisArg: any

      The this binding of callback.

    Returns T

    Returns the maximum value.

  • see

    _.min

    Type parameters

    • T

    Parameters

    • collection: List<T>
    • Optional callback: ListIterator<T, any>
    • Optional thisArg: any

    Returns T

  • see

    _.min

    Type parameters

    • T

    Parameters

    Returns T

  • see

    _.min

    Type parameters

    • T

    Parameters

    • collection: Array<T>
    • pluckValue: string

      _.pluck style callback

    Returns T

  • see

    _.min

    Type parameters

    • T

    Parameters

    • collection: List<T>
    • pluckValue: string

      _.pluck style callback

    Returns T

  • see

    _.min

    Type parameters

    • T

    Parameters

    • collection: Dictionary<T>
    • pluckValue: string

      _.pluck style callback

    Returns T

  • see

    _.min

    Type parameters

    • W

    • T

    Parameters

    • collection: Array<T>
    • whereValue: W

      _.where style callback

    Returns T

  • see

    _.min

    Type parameters

    • W

    • T

    Parameters

    • collection: List<T>
    • whereValue: W

      _.where style callback

    Returns T

  • see

    _.min

    Type parameters

    • W

    • T

    Parameters

    • collection: Dictionary<T>
    • whereValue: W

      _.where style callback

    Returns T

mixin

  • Adds function properties of a source object to the lodash function and chainable wrapper.

    Parameters

    • Optional object: Dictionary<function>

      The object of function properties to add to lodash.

    Returns void

modArgs

  • modArgs<T, TResult>(func: T, ...transforms: Function[]): TResult
  • modArgs<T, TResult>(func: T, transforms: Function[]): TResult
  • Creates a function that runs each argument through a corresponding transform function.

    Type parameters

    • T: Function

    • TResult: Function

    Parameters

    • func: T

      The function to wrap.

    • Rest ...transforms: Function[]

      The functions to transform arguments, specified as individual functions or arrays of functions.

    Returns TResult

    Returns the new function.

  • see

    _.modArgs

    Type parameters

    • T: Function

    • TResult: Function

    Parameters

    • func: T
    • transforms: Function[]

    Returns TResult

negate

  • negate<T>(predicate: T): function
  • negate<T, TResult>(predicate: T): TResult
  • Creates a function that negates the result of the predicate func. The func predicate is invoked with the this binding and arguments of the created function.

    Type parameters

    • T: Function

    Parameters

    • predicate: T

      The predicate to negate.

    Returns function

    Returns the new function.

      • (...args: any[]): boolean
      • Parameters

        • Rest ...args: any[]

        Returns boolean

  • see

    _.negate

    Type parameters

    • T: Function

    • TResult: Function

    Parameters

    • predicate: T

    Returns TResult

noConflict

  • Reverts the '_' variable to its previous value and returns a reference to the lodash function.

    Returns LoDashStatic

    The lodash function.

noop

  • noop(...args: any[]): void
  • A no-operation function that returns undefined regardless of the arguments it receives.

    Parameters

    • Rest ...args: any[]

    Returns void

    undefined

now

  • now(): number
  • Gets the number of milliseconds that have elapsed since the Unix epoch (1 January 1970 00:00:00 UTC).

    Returns number

    The number of milliseconds.

object

  • see

    _.zipObject

    Type parameters

    • TResult: object

    Parameters

    • props: List<string>
    • Optional values: List<any>

    Returns TResult

  • see

    _.zipObject

    Type parameters

    • TResult: object

    Parameters

    Returns Dictionary<any>

omit

  • omit<Omitted, T>(object: T, ...keys: string[]): Omitted
  • omit<Omitted, T>(object: T, keys: string[]): Omitted
  • omit<Omitted, T>(object: T, callback: ObjectIterator<any, boolean>, thisArg?: any): Omitted
  • Creates a shallow clone of object excluding the specified properties. Property names may be specified as individual arguments or as arrays of property names. If a callback is provided it will be executed for each property of object omitting the properties the callback returns truey for. The callback is bound to thisArg and invoked with three arguments; (value, key, object).

    Type parameters

    • Omitted

    • T

    Parameters

    • object: T

      The source object.

    • Rest ...keys: string[]

      The properties to omit.

    Returns Omitted

    An object without the omitted properties.

  • see

    _.omit

    Type parameters

    • Omitted

    • T

    Parameters

    • object: T
    • keys: string[]

    Returns Omitted

  • see

    _.omit

    Type parameters

    • Omitted

    • T

    Parameters

    • object: T
    • callback: ObjectIterator<any, boolean>
    • Optional thisArg: any

    Returns Omitted

once

  • once<T>(func: T): T
  • Creates a function that is restricted to invoking func once. Repeat calls to the function return the value of the first call. The func is invoked with the this binding and arguments of the created function.

    Type parameters

    • T: Function

    Parameters

    • func: T

      The function to restrict.

    Returns T

    Returns the new restricted function.

pad

  • pad(string?: string, length?: number, chars?: string): string
  • Parameters

    • Optional string: string

      The string to pad.

    • Optional length: number

      The padding length.

    • Optional chars: string

      The string used as padding.

    Returns string

    Returns the padded string.

padLeft

  • padLeft(string?: string, length?: number, chars?: string): string
  • Pads string on the left side if it’s shorter than length. Padding characters are truncated if they exceed length.

    Parameters

    • Optional string: string

      The string to pad.

    • Optional length: number

      The padding length.

    • Optional chars: string

      The string used as padding.

    Returns string

    Returns the padded string.

padRight

  • padRight(string?: string, length?: number, chars?: string): string
  • Pads string on the right side if it’s shorter than length. Padding characters are truncated if they exceed length.

    Parameters

    • Optional string: string

      The string to pad.

    • Optional length: number

      The padding length.

    • Optional chars: string

      The string used as padding.

    Returns string

    Returns the padded string.

pairs

  • pairs(object?: any): any[]
  • Creates a two dimensional array of an object's key-value pairs, i.e. [[key1, value1], [key2, value2]].

    Parameters

    • Optional object: any

      The object to inspect.

    Returns any[]

    Aew array of key-value pairs.

parseInt

  • parseInt(string: string, radix?: number): number
  • Converts string to an integer of the specified radix. If radix is undefined or 0, a radix of 10 is used unless value is a hexadecimal, in which case a radix of 16 is used. Note: This method aligns with the ES5 implementation of parseInt.

    Parameters

    • string: string

      The string to convert.

    • Optional radix: number

      The radix to interpret value by.

    Returns number

    Returns the converted integer.

partial

  • partial(func: Function, ...args: any[]): Function
  • Creates a function that, when called, invokes func with any additional partial arguments prepended to those provided to the new function. This method is similar to _.bind except it does not alter the this binding.

    Parameters

    • func: Function

      The function to partially apply arguments to.

    • Rest ...args: any[]

      Arguments to be partially applied.

    Returns Function

    The new partially applied function.

partialRight

  • partialRight(func: Function, ...args: any[]): Function
  • This method is like _.partial except that partial arguments are appended to those provided to the new function.

    Parameters

    • func: Function

      The function to partially apply arguments to.

    • Rest ...args: any[]

      Arguments to be partially applied.

    Returns Function

    The new partially applied function.

partition

  • partition<T>(collection: List<T>, callback: ListIterator<T, boolean>, thisArg?: any): T[]
  • partition<T>(collection: Dictionary<T>, callback: DictionaryIterator<T, boolean>, thisArg?: any): T[]
  • partition<W, T>(collection: List<T>, whereValue: W): T[]
  • partition<W, T>(collection: Dictionary<T>, whereValue: W): T[]
  • partition<T>(collection: List<T>, path: string, srcValue: any): T[]
  • partition<T>(collection: Dictionary<T>, path: string, srcValue: any): T[]
  • partition<T>(collection: List<T>, pluckValue: string): T[]
  • partition<T>(collection: Dictionary<T>, pluckValue: string): T[]
  • Creates an array of elements split into two groups, the first of which contains elements predicate returns truthy for, while the second of which contains elements predicate returns falsey for. The predicate is bound to thisArg and invoked with three arguments: (value, index|key, collection).

    If a property name is provided for predicate the created _.property style callback returns the property value of the given element.

    If a value is also provided for thisArg the created _.matchesProperty style callback returns true for elements that have a matching property value, else false.

    If an object is provided for predicate the created _.matches style callback returns true for elements that have the properties of the given object, else false.

    Type parameters

    • T

    Parameters

    • collection: List<T>

      The collection to iterate over.

    • callback: ListIterator<T, boolean>

      The function called per iteration.

    • Optional thisArg: any

      The this binding of predicate.

    Returns T[]

    Returns the array of grouped elements.

  • see

    _.partition

    Type parameters

    • T

    Parameters

    Returns T[]

  • see

    _.partition

    Type parameters

    • W

    • T

    Parameters

    • collection: List<T>
    • whereValue: W

    Returns T[]

  • see

    _.partition

    Type parameters

    • W

    • T

    Parameters

    Returns T[]

  • see

    _.partition

    Type parameters

    • T

    Parameters

    • collection: List<T>
    • path: string
    • srcValue: any

    Returns T[]

  • see

    _.partition

    Type parameters

    • T

    Parameters

    • collection: Dictionary<T>
    • path: string
    • srcValue: any

    Returns T[]

  • see

    _.partition

    Type parameters

    • T

    Parameters

    • collection: List<T>
    • pluckValue: string

    Returns T[]

  • see

    _.partition

    Type parameters

    • T

    Parameters

    Returns T[]

pick

  • pick<Picked, T>(object: T, ...keys: string[]): Picked
  • pick<Picked, T>(object: T, keys: string[]): Picked
  • pick<Picked, T>(object: T, callback: ObjectIterator<any, boolean>, thisArg?: any): Picked
  • Creates a shallow clone of object composed of the specified properties. Property names may be specified as individual arguments or as arrays of property names. If a callback is provided it will be executed for each property of object picking the properties the callback returns truey for. The callback is bound to thisArg and invoked with three arguments; (value, key, object).

    Type parameters

    • Picked

    • T

    Parameters

    • object: T

      Object to strip unwanted key/value pairs.

    • Rest ...keys: string[]

      Property names to pick

    Returns Picked

    An object composed of the picked properties.

  • see

    _.pick

    Type parameters

    • Picked

    • T

    Parameters

    • object: T
    • keys: string[]

    Returns Picked

  • see

    _.pick

    Type parameters

    • Picked

    • T

    Parameters

    • object: T
    • callback: ObjectIterator<any, boolean>
    • Optional thisArg: any

    Returns Picked

pluck

  • pluck<T>(collection: Array<T>, property: string | string[]): any[]
  • pluck<T>(collection: List<T>, property: string | string[]): any[]
  • pluck<T>(collection: Dictionary<T>, property: string | string[]): any[]
  • Retrieves the value of a specified property from all elements in the collection.

    Type parameters

    • T: object

    Parameters

    • collection: Array<T>

      The collection to iterate over.

    • property: string | string[]

      The property to pluck.

    Returns any[]

    A new array of property values.

  • see

    _.pluck

    Type parameters

    • T: object

    Parameters

    • collection: List<T>
    • property: string | string[]

    Returns any[]

  • see

    _.pluck

    Type parameters

    • T: object

    Parameters

    • collection: Dictionary<T>
    • property: string | string[]

    Returns any[]

property

  • property<TObj, TResult>(path: string | string[]): function
  • Creates a function that returns the property value at path on a given object.

    Type parameters

    • TObj

    • TResult

    Parameters

    • path: string | string[]

      The path of the property to get.

    Returns function

    Returns the new function.

      • (obj: TObj): TResult
      • Parameters

        • obj: TObj

        Returns TResult

propertyOf

  • propertyOf<T>(object: T): function
  • The opposite of _.property; this method creates a function that returns the property value at a given path on object.

    Type parameters

    • T: object

    Parameters

    • object: T

      The object to query.

    Returns function

    Returns the new function.

      • (path: string | string[]): any
      • Parameters

        • path: string | string[]

        Returns any

pull

  • pull<T>(array: Array<T>, ...values: T[]): T[]
  • pull<T>(array: List<T>, ...values: T[]): T[]
  • Removes all provided values from the given array using strict equality for comparisons, i.e. ===.

    Type parameters

    • T

    Parameters

    • array: Array<T>

      The array to modify.

    • Rest ...values: T[]

      The values to remove.

    Returns T[]

    array.

  • see

    _.pull

    Type parameters

    • T

    Parameters

    • array: List<T>
    • Rest ...values: T[]

    Returns T[]

pullAt

  • pullAt(array: Array<any>, ...values: any[]): any[]
  • pullAt(array: List<any>, ...values: any[]): any[]
  • Removes all provided values from the given array using strict equality for comparisons, i.e. ===.

    Parameters

    • array: Array<any>

      The array to modify.

    • Rest ...values: any[]

      The values to remove.

    Returns any[]

    array.

  • see

    _.pull

    Parameters

    • array: List<any>
    • Rest ...values: any[]

    Returns any[]

random

  • random(max: number, floating?: boolean): number
  • random(min: number, max: number, floating?: boolean): number
  • Produces a random number between min and max (inclusive). If only one argument is provided a number between 0 and the given number will be returned. If floating is truey or either min or max are floats a floating-point number will be returned instead of an integer.

    Parameters

    • max: number

      The maximum possible value.

    • Optional floating: boolean

      Specify returning a floating-point number.

    Returns number

    A random number.

  • see

    _.random

    Parameters

    • min: number

      The minimum possible value.

    • max: number
    • Optional floating: boolean

    Returns number

    A random number between min and max.

range

  • range(start: number, end: number, step?: number): number[]
  • range(end: number, step?: number): number[]
  • Creates an array of numbers (positive and/or negative) progressing from start up to, but not including, end. If end is not specified it’s set to start with start then set to 0. If end is less than start a zero-length range is created unless a negative step is specified.

    Parameters

    • start: number

      The start of the range.

    • end: number

      The end of the range.

    • Optional step: number

      The value to increment or decrement by.

    Returns number[]

    Returns a new range array.

  • see

    _.range

    Parameters

    • end: number
    • Optional step: number

    Returns number[]

rearg

  • rearg<TResult>(func: Function, indexes: number[]): TResult
  • rearg<TResult>(func: Function, ...indexes: number[]): TResult
  • Creates a function that invokes func with arguments arranged according to the specified indexes where the argument value at the first index is provided as the first argument, the argument value at the second index is provided as the second argument, and so on.

    Type parameters

    • TResult: Function

    Parameters

    • func: Function

      The function to rearrange arguments for.

    • indexes: number[]

      The arranged argument indexes, specified as individual indexes or arrays of indexes.

    Returns TResult

    Returns the new function.

  • see

    _.rearg

    Type parameters

    • TResult: Function

    Parameters

    • func: Function
    • Rest ...indexes: number[]

    Returns TResult

reduce

  • reduce<T, TResult>(collection: Array<T>, callback: MemoIterator<T, TResult>, accumulator: TResult, thisArg?: any): TResult
  • reduce<T, TResult>(collection: List<T>, callback: MemoIterator<T, TResult>, accumulator: TResult, thisArg?: any): TResult
  • reduce<T, TResult>(collection: Dictionary<T>, callback: MemoIterator<T, TResult>, accumulator: TResult, thisArg?: any): TResult
  • reduce<T, TResult>(collection: Array<T>, callback: MemoIterator<T, TResult>, thisArg?: any): TResult
  • reduce<T, TResult>(collection: List<T>, callback: MemoIterator<T, TResult>, thisArg?: any): TResult
  • reduce<T, TResult>(collection: Dictionary<T>, callback: MemoIterator<T, TResult>, thisArg?: any): TResult
  • Reduces a collection to a value which is the accumulated result of running each element in the collection through the callback, where each successive callback execution consumes the return value of the previous execution. If accumulator is not provided the first element of the collection will be used as the initial accumulator value. The callback is bound to thisArg and invoked with four arguments; (accumulator, value, index|key, collection).

    Type parameters

    • T

    • TResult

    Parameters

    • collection: Array<T>

      The collection to iterate over.

    • callback: MemoIterator<T, TResult>

      The function called per iteration.

    • accumulator: TResult

      Initial value of the accumulator.

    • Optional thisArg: any

      The this binding of callback.

    Returns TResult

    Returns the accumulated value.

  • see

    _.reduce

    Type parameters

    • T

    • TResult

    Parameters

    • collection: List<T>
    • callback: MemoIterator<T, TResult>
    • accumulator: TResult
    • Optional thisArg: any

    Returns TResult

  • see

    _.reduce

    Type parameters

    • T

    • TResult

    Parameters

    Returns TResult

  • see

    _.reduce

    Type parameters

    • T

    • TResult

    Parameters

    • collection: Array<T>
    • callback: MemoIterator<T, TResult>
    • Optional thisArg: any

    Returns TResult

  • see

    _.reduce

    Type parameters

    • T

    • TResult

    Parameters

    Returns TResult

  • see

    _.reduce

    Type parameters

    • T

    • TResult

    Parameters

    Returns TResult

reduceRight

  • reduceRight<T, TResult>(collection: Array<T>, callback: MemoIterator<T, TResult>, accumulator: TResult, thisArg?: any): TResult
  • reduceRight<T, TResult>(collection: List<T>, callback: MemoIterator<T, TResult>, accumulator: TResult, thisArg?: any): TResult
  • reduceRight<T, TResult>(collection: Dictionary<T>, callback: MemoIterator<T, TResult>, accumulator: TResult, thisArg?: any): TResult
  • reduceRight<T, TResult>(collection: Array<T>, callback: MemoIterator<T, TResult>, thisArg?: any): TResult
  • reduceRight<T, TResult>(collection: List<T>, callback: MemoIterator<T, TResult>, thisArg?: any): TResult
  • reduceRight<T, TResult>(collection: Dictionary<T>, callback: MemoIterator<T, TResult>, thisArg?: any): TResult
  • This method is like _.reduce except that it iterates over elements of a collection from right to left.

    Type parameters

    • T

    • TResult

    Parameters

    • collection: Array<T>

      The collection to iterate over.

    • callback: MemoIterator<T, TResult>

      The function called per iteration.

    • accumulator: TResult

      Initial value of the accumulator.

    • Optional thisArg: any

      The this binding of callback.

    Returns TResult

    The accumulated value.

  • see

    _.reduceRight

    Type parameters

    • T

    • TResult

    Parameters

    • collection: List<T>
    • callback: MemoIterator<T, TResult>
    • accumulator: TResult
    • Optional thisArg: any

    Returns TResult

  • see

    _.reduceRight

    Type parameters

    • T

    • TResult

    Parameters

    Returns TResult

  • see

    _.reduceRight

    Type parameters

    • T

    • TResult

    Parameters

    • collection: Array<T>
    • callback: MemoIterator<T, TResult>
    • Optional thisArg: any

    Returns TResult

  • see

    _.reduceRight

    Type parameters

    • T

    • TResult

    Parameters

    Returns TResult

  • see

    _.reduceRight

    Type parameters

    • T

    • TResult

    Parameters

    Returns TResult

reject

  • reject<T>(collection: Array<T>, callback: ListIterator<T, boolean>, thisArg?: any): T[]
  • reject<T>(collection: List<T>, callback: ListIterator<T, boolean>, thisArg?: any): T[]
  • reject<T>(collection: Dictionary<T>, callback: DictionaryIterator<T, boolean>, thisArg?: any): T[]
  • reject<T>(collection: Array<T>, pluckValue: string): T[]
  • reject<T>(collection: List<T>, pluckValue: string): T[]
  • reject<T>(collection: Dictionary<T>, pluckValue: string): T[]
  • reject<W, T>(collection: Array<T>, whereValue: W): T[]
  • reject<W, T>(collection: List<T>, whereValue: W): T[]
  • reject<W, T>(collection: Dictionary<T>, whereValue: W): T[]
  • The opposite of _.filter this method returns the elements of a collection that the callback does not return truey for.

    If a property name is provided for callback the created "_.pluck" style callback will return the property value of the given element.

    If an object is provided for callback the created "_.where" style callback will return true for elements that have the properties of the given object, else false.

    Type parameters

    • T

    Parameters

    • collection: Array<T>

      The collection to iterate over.

    • callback: ListIterator<T, boolean>

      The function called per iteration.

    • Optional thisArg: any

      The this binding of callback.

    Returns T[]

    A new array of elements that failed the callback check.

  • see

    _.reject

    Type parameters

    • T

    Parameters

    Returns T[]

  • see

    _.reject

    Type parameters

    • T

    Parameters

    Returns T[]

  • see

    _.reject

    Type parameters

    • T

    Parameters

    • collection: Array<T>
    • pluckValue: string

      _.pluck style callback

    Returns T[]

  • see

    _.reject

    Type parameters

    • T

    Parameters

    • collection: List<T>
    • pluckValue: string

      _.pluck style callback

    Returns T[]

  • see

    _.reject

    Type parameters

    • T

    Parameters

    • collection: Dictionary<T>
    • pluckValue: string

      _.pluck style callback

    Returns T[]

  • see

    _.reject

    Type parameters

    • W

    • T

    Parameters

    • collection: Array<T>
    • whereValue: W

      _.where style callback

    Returns T[]

  • see

    _.reject

    Type parameters

    • W

    • T

    Parameters

    • collection: List<T>
    • whereValue: W

      _.where style callback

    Returns T[]

  • see

    _.reject

    Type parameters

    • W

    • T

    Parameters

    • collection: Dictionary<T>
    • whereValue: W

      _.where style callback

    Returns T[]

remove

  • remove<T>(array: Array<T>, callback?: ListIterator<T, boolean>, thisArg?: any): T[]
  • remove<T>(array: List<T>, callback?: ListIterator<T, boolean>, thisArg?: any): T[]
  • remove<T>(array: Array<T>, pluckValue?: string): T[]
  • remove<T>(array: List<T>, pluckValue?: string): T[]
  • remove<W, T>(array: Array<T>, wherealue?: Dictionary<W>): T[]
  • remove<W, T>(array: List<T>, wherealue?: Dictionary<W>): T[]
  • remove<T>(array: Array<T>, item: T): T[]
  • Removes all elements from an array that the callback returns truey for and returns an array of removed elements. The callback is bound to thisArg and invoked with three arguments; (value, index, array).

    If a property name is provided for callback the created "_.pluck" style callback will return the property value of the given element.

    If an object is provided for callback the created "_.where" style callback will return true for elements that have the properties of the given object, else false.

    Type parameters

    • T

    Parameters

    • array: Array<T>

      The array to modify.

    • Optional callback: ListIterator<T, boolean>

      The function called per iteration.

    • Optional thisArg: any

      The this binding of callback.

    Returns T[]

    A new array of removed elements.

  • see

    _.remove

    Type parameters

    • T

    Parameters

    • array: List<T>
    • Optional callback: ListIterator<T, boolean>
    • Optional thisArg: any

    Returns T[]

  • see

    _.remove

    Type parameters

    • T

    Parameters

    • array: Array<T>
    • Optional pluckValue: string

      _.pluck style callback

    Returns T[]

  • see

    _.remove

    Type parameters

    • T

    Parameters

    • array: List<T>
    • Optional pluckValue: string

      _.pluck style callback

    Returns T[]

  • see

    _.remove

    Type parameters

    • W

    • T

    Parameters

    • array: Array<T>
    • Optional wherealue: Dictionary<W>

    Returns T[]

  • see

    _.remove

    Type parameters

    • W

    • T

    Parameters

    Returns T[]

  • see

    _.remove

    Type parameters

    • T

    Parameters

    • array: Array<T>
    • item: T

      The item to remove

    Returns T[]

repeat

  • repeat(string?: string, n?: number): string
  • Repeats the given string n times.

    Parameters

    • Optional string: string

      The string to repeat.

    • Optional n: number

      The number of times to repeat the string.

    Returns string

    Returns the repeated string.

rest

  • rest<T>(array: Array<T>): T[]
  • rest<T>(array: List<T>): T[]
  • rest<T>(array: Array<T>, callback: ListIterator<T, boolean>, thisArg?: any): T[]
  • rest<T>(array: List<T>, callback: ListIterator<T, boolean>, thisArg?: any): T[]
  • rest<T>(array: Array<T>, n: number): T[]
  • rest<T>(array: List<T>, n: number): T[]
  • rest<T>(array: Array<T>, pluckValue: string): T[]
  • rest<T>(array: List<T>, pluckValue: string): T[]
  • rest<W, T>(array: Array<T>, whereValue: W): T[]
  • rest<W, T>(array: List<T>, whereValue: W): T[]
  • The opposite of _.initial this method gets all but the first element or first n elements of an array. If a callback function is provided elements at the beginning of the array are excluded from the result as long as the callback returns truey. The callback is bound to thisArg and invoked with three arguments; (value, index, array).

    If a property name is provided for callback the created "_.pluck" style callback will return the property value of the given element.

    If an object is provided for callback the created "_.where" style callback will return true for elements that have the properties of the given object, else false.

    Type parameters

    • T

    Parameters

    • array: Array<T>

      The array to query.

    Returns T[]

    Returns a slice of array.

  • see

    _.rest

    Type parameters

    • T

    Parameters

    Returns T[]

  • see

    _.rest

    Type parameters

    • T

    Parameters

    • array: Array<T>
    • callback: ListIterator<T, boolean>
    • Optional thisArg: any

    Returns T[]

  • see

    _.rest

    Type parameters

    • T

    Parameters

    Returns T[]

  • see

    _.rest

    Type parameters

    • T

    Parameters

    • array: Array<T>
    • n: number

    Returns T[]

  • see

    _.rest

    Type parameters

    • T

    Parameters

    • array: List<T>
    • n: number

    Returns T[]

  • see

    _.rest

    Type parameters

    • T

    Parameters

    • array: Array<T>
    • pluckValue: string

    Returns T[]

  • see

    _.rest

    Type parameters

    • T

    Parameters

    • array: List<T>
    • pluckValue: string

    Returns T[]

  • see

    _.rest

    Type parameters

    • W

    • T

    Parameters

    • array: Array<T>
    • whereValue: W

    Returns T[]

  • see

    _.rest

    Type parameters

    • W

    • T

    Parameters

    • array: List<T>
    • whereValue: W

    Returns T[]

restParam

  • restParam<TResult>(func: Function, start?: number): TResult
  • restParam<TResult, TFunc>(func: TFunc, start?: number): TResult
  • Creates a function that invokes func with the this binding of the created function and arguments from start and beyond provided as an array.

    Type parameters

    • TResult: Function

    Parameters

    • func: Function

      The function to apply a rest parameter to.

    • Optional start: number

      The start position of the rest parameter.

    Returns TResult

    Returns the new function.

  • see

    _.restParam

    Type parameters

    • TResult: Function

    • TFunc: Function

    Parameters

    • func: TFunc
    • Optional start: number

    Returns TResult

result

  • result<T>(object: any, path: string | string[], defaultValue?: T): T
  • Resolves the value of property on object. If property is a function it will be invoked with the this binding of object and its result returned, else the property value is returned. If object is false then undefined is returned.

    Type parameters

    • T

    Parameters

    • object: any

      The object to query.

    • path: string | string[]

      The path of the property to resolve.

    • Optional defaultValue: T

      The value returned if the resolved value is undefined.

    Returns T

    The resolved value.

round

  • round(n: number, precision?: number): number
  • Calculates n rounded to precision.

    Parameters

    • n: number

      The number to round.

    • Optional precision: number

      The precision to round to.

    Returns number

    Returns the rounded number.

runInContext

  • Create a new lodash function using the given context object.

    Parameters

    • context: any

      The context object

    Returns LoDashStatic

    The lodash function.

sample

  • sample<T>(collection: Array<T>): T
  • sample<T>(collection: List<T>): T
  • sample<T>(collection: Dictionary<T>): T
  • sample<T>(collection: Array<T>, n: number): T[]
  • sample<T>(collection: List<T>, n: number): T[]
  • sample<T>(collection: Dictionary<T>, n: number): T[]
  • Retrieves a random element or n random elements from a collection.

    Type parameters

    • T

    Parameters

    • collection: Array<T>

      The collection to sample.

    Returns T

    Returns the random sample(s) of collection.

  • see

    _.sample

    Type parameters

    • T

    Parameters

    • collection: List<T>

    Returns T

  • see

    _.sample

    Type parameters

    • T

    Parameters

    Returns T

  • see

    _.sample

    Type parameters

    • T

    Parameters

    • collection: Array<T>
    • n: number

      The number of elements to sample.

    Returns T[]

  • see

    _.sample

    Type parameters

    • T

    Parameters

    • collection: List<T>
    • n: number

      The number of elements to sample.

    Returns T[]

  • see

    _.sample

    Type parameters

    • T

    Parameters

    • collection: Dictionary<T>
    • n: number

      The number of elements to sample.

    Returns T[]

select

  • select<T>(collection: Array<T>, callback: ListIterator<T, boolean>, thisArg?: any): T[]
  • select<T>(collection: List<T>, callback: ListIterator<T, boolean>, thisArg?: any): T[]
  • select<T>(collection: Dictionary<T>, callback: DictionaryIterator<T, boolean>, thisArg?: any): T[]
  • select<T>(collection: Array<T>, pluckValue: string): T[]
  • select<T>(collection: List<T>, pluckValue: string): T[]
  • select<T>(collection: Dictionary<T>, pluckValue: string): T[]
  • select<W, T>(collection: Array<T>, whereValue: W): T[]
  • select<W, T>(collection: List<T>, whereValue: W): T[]
  • select<W, T>(collection: Dictionary<T>, whereValue: W): T[]
  • see

    _.filter

    Type parameters

    • T

    Parameters

    • collection: Array<T>
    • callback: ListIterator<T, boolean>
    • Optional thisArg: any

    Returns T[]

  • see

    _.filter

    Type parameters

    • T

    Parameters

    Returns T[]

  • see

    _.filter

    Type parameters

    • T

    Parameters

    Returns T[]

  • see

    _.filter

    Type parameters

    • T

    Parameters

    • collection: Array<T>
    • pluckValue: string

      _.pluck style callback

    Returns T[]

  • see

    _.filter

    Type parameters

    • T

    Parameters

    • collection: List<T>
    • pluckValue: string

      _.pluck style callback

    Returns T[]

  • see

    _.filter

    Type parameters

    • T

    Parameters

    • collection: Dictionary<T>
    • pluckValue: string

      _.pluck style callback

    Returns T[]

  • see

    _.filter

    Type parameters

    • W

    • T

    Parameters

    • collection: Array<T>
    • whereValue: W

    Returns T[]

  • see

    _.filter

    Type parameters

    • W

    • T

    Parameters

    • collection: List<T>
    • whereValue: W

    Returns T[]

  • see

    _.filter

    Type parameters

    • W

    • T

    Parameters

    Returns T[]

set

  • set<T>(object: T, path: string | string[], value: any): T
  • Sets the property value of path on object. If a portion of path does not exist it is created.

    Type parameters

    • T

    Parameters

    • object: T

      The object to augment.

    • path: string | string[]

      The path of the property to set.

    • value: any

      The value to set.

    Returns T

    Returns object.

shuffle

  • shuffle<T>(collection: Array<T>): T[]
  • shuffle<T>(collection: List<T>): T[]
  • shuffle<T>(collection: Dictionary<T>): T[]
  • Creates an array of shuffled values, using a version of the Fisher-Yates shuffle. See http://en.wikipedia.org/wiki/Fisher-Yates_shuffle.

    Type parameters

    • T

    Parameters

    • collection: Array<T>

      The collection to shuffle.

    Returns T[]

    Returns a new shuffled collection.

  • see

    _.shuffle

    Type parameters

    • T

    Parameters

    • collection: List<T>

    Returns T[]

  • see

    _.shuffle

    Type parameters

    • T

    Parameters

    Returns T[]

size

  • size<T>(collection: Array<T>): number
  • size<T>(collection: List<T>): number
  • size<T>(object: T): number
  • size(aString: string): number
  • Gets the size of the collection by returning collection.length for arrays and array-like objects or the number of own enumerable properties for objects.

    Type parameters

    • T

    Parameters

    • collection: Array<T>

      The collection to inspect.

    Returns number

    collection.length

  • see

    _.size

    Type parameters

    • T

    Parameters

    • collection: List<T>

    Returns number

  • see

    _.size

    Type parameters

    • T: object

    Parameters

    • object: T

      The object to inspect

    Returns number

    The number of own enumerable properties.

  • see

    _.size

    Parameters

    • aString: string

      The string to inspect

    Returns number

    The length of aString

snakeCase

  • snakeCase(string?: string): string
  • Converts string to snake case.

    Parameters

    • Optional string: string

      The string to convert.

    Returns string

    Returns the snake cased string.

some

  • some<T>(collection: Array<T>, callback?: ListIterator<T, boolean>, thisArg?: any): boolean
  • some<T>(collection: List<T>, callback?: ListIterator<T, boolean>, thisArg?: any): boolean
  • some<T>(collection: Dictionary<T>, callback?: DictionaryIterator<T, boolean>, thisArg?: any): boolean
  • some(collection: object, callback?: ListIterator<object, boolean>, thisArg?: any): boolean
  • some<T>(collection: Array<T>, pluckValue: string): boolean
  • some<T>(collection: List<T>, pluckValue: string): boolean
  • some<T>(collection: Dictionary<T>, pluckValue: string): boolean
  • some<W, T>(collection: Array<T>, whereValue: W): boolean
  • some<W, T>(collection: List<T>, whereValue: W): boolean
  • some<W, T>(collection: Dictionary<T>, whereValue: W): boolean
  • Checks if the callback returns a truey value for any element of a collection. The function returns as soon as it finds a passing value and does not iterate over the entire collection. The callback is bound to thisArg and invoked with three arguments; (value, index|key, collection).

    If a property name is provided for callback the created "_.pluck" style callback will return the property value of the given element.

    If an object is provided for callback the created "_.where" style callback will return true for elements that have the properties of the given object, else false.

    Type parameters

    • T

    Parameters

    • collection: Array<T>

      The collection to iterate over.

    • Optional callback: ListIterator<T, boolean>

      The function called per iteration.

    • Optional thisArg: any

      The this binding of callback.

    Returns boolean

    True if any element passed the callback check, else false.

  • see

    _.some

    Type parameters

    • T

    Parameters

    • collection: List<T>
    • Optional callback: ListIterator<T, boolean>
    • Optional thisArg: any

    Returns boolean

  • see

    _.some

    Type parameters

    • T

    Parameters

    Returns boolean

  • see

    _.some

    Parameters

    • collection: object
    • Optional callback: ListIterator<object, boolean>
    • Optional thisArg: any

    Returns boolean

  • see

    _.some

    Type parameters

    • T

    Parameters

    • collection: Array<T>
    • pluckValue: string

      _.pluck style callback

    Returns boolean

  • see

    _.some

    Type parameters

    • T

    Parameters

    • collection: List<T>
    • pluckValue: string

      _.pluck style callback

    Returns boolean

  • see

    _.some

    Type parameters

    • T

    Parameters

    • collection: Dictionary<T>
    • pluckValue: string

      _.pluck style callback

    Returns boolean

  • see

    _.some

    Type parameters

    • W

    • T

    Parameters

    • collection: Array<T>
    • whereValue: W

      _.where style callback

    Returns boolean

  • see

    _.some

    Type parameters

    • W

    • T

    Parameters

    • collection: List<T>
    • whereValue: W

      _.where style callback

    Returns boolean

  • see

    _.some

    Type parameters

    • W

    • T

    Parameters

    • collection: Dictionary<T>
    • whereValue: W

      _.where style callback

    Returns boolean

sortBy

  • sortBy<T, TSort>(collection: Array<T>, iteratee?: ListIterator<T, TSort>, thisArg?: any): T[]
  • sortBy<T, TSort>(collection: List<T>, iteratee?: ListIterator<T, TSort>, thisArg?: any): T[]
  • sortBy<T>(collection: Array<T>, pluckValue: string): T[]
  • sortBy<T>(collection: List<T>, pluckValue: string): T[]
  • sortBy<W, T>(collection: Array<T>, whereValue: W): T[]
  • sortBy<W, T>(collection: List<T>, whereValue: W): T[]
  • Creates an array of elements, sorted in ascending order by the results of running each element in a collection through the callback. This method performs a stable sort, that is, it will preserve the original sort order of equal elements. The callback is bound to thisArg and invoked with three arguments; (value, index|key, collection).

    If a property name is provided for callback the created "_.pluck" style callback will return the property value of the given element.

    If a value is also provided for thisArg the created "_.matchesProperty" style callback returns true for elements that have a matching property value, else false.

    If an object is provided for an iteratee the created "_.matches" style callback returns true for elements that have the properties of the given object, else false.

    Type parameters

    • T

    • TSort

    Parameters

    • collection: Array<T>

      The collection to iterate over.

    • Optional iteratee: ListIterator<T, TSort>
    • Optional thisArg: any

      The this binding of callback.

    Returns T[]

    A new array of sorted elements.

  • see

    _.sortBy

    Type parameters

    • T

    • TSort

    Parameters

    • collection: List<T>
    • Optional iteratee: ListIterator<T, TSort>
    • Optional thisArg: any

    Returns T[]

  • see

    _.sortBy

    Type parameters

    • T

    Parameters

    • collection: Array<T>
    • pluckValue: string

      _.pluck style callback

    Returns T[]

  • see

    _.sortBy

    Type parameters

    • T

    Parameters

    • collection: List<T>
    • pluckValue: string

      _.pluck style callback

    Returns T[]

  • see

    _.sortBy

    Type parameters

    • W

    • T

    Parameters

    • collection: Array<T>
    • whereValue: W

      _.where style callback

    Returns T[]

  • see

    _.sortBy

    Type parameters

    • W

    • T

    Parameters

    • collection: List<T>
    • whereValue: W

      _.where style callback

    Returns T[]

sortByAll

  • sortByAll<T>(collection: Array<T> | List<T>, ...args: ListIterator<T, boolean> | Object | string): T[]
  • sortByAll<T>(collection: Array<T>, iteratees: ListIterator<T, any> | string | Object): T[]
  • sortByAll<T>(collection: List<T>, iteratees: ListIterator<T, any> | string | Object): T[]
  • sortByAll<T>(collection: Array<T>, ...iteratees: ListIterator<T, any> | string | Object): T[]
  • sortByAll<T>(collection: List<T>, ...iteratees: ListIterator<T, any> | string | Object): T[]
  • Sorts by all the given arguments, using either ListIterator, pluckValue, or whereValue foramts

    Type parameters

    • T

    Parameters

    • collection: Array<T> | List<T>
    • Rest ...args: ListIterator<T, boolean> | Object | string

      The rules by which to sort

    Returns T[]

  • This method is like "_.sortBy" except that it can sort by multiple iteratees or property names.

    If a property name is provided for an iteratee the created "_.property" style callback returns the property value of the given element.

    If a value is also provided for thisArg the created "_.matchesProperty" style callback returns true for elements that have a matching property value, else false.

    If an object is provided for an iteratee the created "_.matches" style callback returns true for elements that have the properties of the given object, else false.

    Type parameters

    • T

    Parameters

    • collection: Array<T>

      The collection to iterate over.

    • iteratees: ListIterator<T, any> | string | Object

    Returns T[]

    A new array of sorted elements.

  • see

    _.sortByAll

    Type parameters

    • T

    Parameters

    Returns T[]

  • see

    _.sortByAll

    Type parameters

    • T

    Parameters

    • collection: Array<T>
    • Rest ...iteratees: ListIterator<T, any> | string | Object

    Returns T[]

  • see

    _.sortByAll

    Type parameters

    • T

    Parameters

    Returns T[]

sortByOrder

  • sortByOrder<T>(collection: Array<T>, iteratees: ListIterator<T, any> | string | Object, orders?: boolean[]): T[]
  • sortByOrder<T>(collection: List<T>, iteratees: ListIterator<T, any> | string | Object, orders?: boolean[]): T[]
  • sortByOrder<T>(collection: Array<T>, iteratees: ListIterator<T, any> | string | Object, orders?: string[]): T[]
  • sortByOrder<T>(collection: List<T>, iteratees: ListIterator<T, any> | string | Object, orders?: string[]): T[]
  • This method is like "_.sortByAll" except that it allows specifying the sort orders of the iteratees to sort by. If orders is unspecified, all values are sorted in ascending order. Otherwise, a value is sorted in ascending order if its corresponding order is "asc", and descending if "desc".

    If a property name is provided for an iteratee the created "_.property" style callback returns the property value of the given element.

    If an object is provided for an iteratee the created "_.matches" style callback returns true for elements that have the properties of the given object, else false.

    Type parameters

    • T

    Parameters

    • collection: Array<T>

      The collection to iterate over.

    • iteratees: ListIterator<T, any> | string | Object
    • Optional orders: boolean[]

    Returns T[]

    A new array of sorted elements.

  • see

    _.sortByOrder

    Type parameters

    • T

    Parameters

    • collection: List<T>
    • iteratees: ListIterator<T, any> | string | Object
    • Optional orders: boolean[]

    Returns T[]

  • see

    _.sortByOrder

    Type parameters

    • T

    Parameters

    • collection: Array<T>
    • iteratees: ListIterator<T, any> | string | Object
    • Optional orders: string[]

    Returns T[]

  • see

    _.sortByOrder

    Type parameters

    • T

    Parameters

    • collection: List<T>
    • iteratees: ListIterator<T, any> | string | Object
    • Optional orders: string[]

    Returns T[]

sortedIndex

  • sortedIndex<T, TSort>(array: Array<T>, value: T, callback?: function, thisArg?: any): number
  • sortedIndex<T, TSort>(array: List<T>, value: T, callback?: function, thisArg?: any): number
  • sortedIndex<T>(array: Array<T>, value: T, pluckValue: string): number
  • sortedIndex<T>(array: List<T>, value: T, pluckValue: string): number
  • sortedIndex<W, T>(array: Array<T>, value: T, whereValue: W): number
  • sortedIndex<W, T>(array: List<T>, value: T, whereValue: W): number
  • Uses a binary search to determine the smallest index at which a value should be inserted into a given sorted array in order to maintain the sort order of the array. If a callback is provided it will be executed for value and each element of array to compute their sort ranking. The callback is bound to thisArg and invoked with one argument; (value).

    If a property name is provided for callback the created "_.pluck" style callback will return the property value of the given element.

    If an object is provided for callback the created "_.where" style callback will return true for elements that have the properties of the given object, else false.

    Type parameters

    • T

    • TSort

    Parameters

    • array: Array<T>

      The sorted list.

    • value: T

      The value to determine its index within list.

    • Optional callback: function

      Iterator to compute the sort ranking of each value, optional.

        • (x: T): TSort
        • Parameters

          • x: T

          Returns TSort

    • Optional thisArg: any

    Returns number

    The index at which value should be inserted into array.

  • see

    _.sortedIndex

    Type parameters

    • T

    • TSort

    Parameters

    • array: List<T>
    • value: T
    • Optional callback: function
        • (x: T): TSort
        • Parameters

          • x: T

          Returns TSort

    • Optional thisArg: any

    Returns number

  • see

    _.sortedIndex

    Type parameters

    • T

    Parameters

    • array: Array<T>
    • value: T
    • pluckValue: string

      the _.pluck style callback

    Returns number

  • see

    _.sortedIndex

    Type parameters

    • T

    Parameters

    • array: List<T>
    • value: T
    • pluckValue: string

      the _.pluck style callback

    Returns number

  • see

    _.sortedIndex

    Type parameters

    • W

    • T

    Parameters

    • array: Array<T>
    • value: T
    • whereValue: W

    Returns number

  • see

    _.sortedIndex

    Type parameters

    • W

    • T

    Parameters

    • array: List<T>
    • value: T
    • whereValue: W

    Returns number

spread

  • spread<TResult>(func: Function): TResult
  • Creates a function that invokes func with the this binding of the created function and an array of arguments much like Function#apply.

    Type parameters

    • TResult: Function

    Parameters

    • func: Function

      The function to spread arguments over.

    Returns TResult

    Returns the new function.

startCase

  • startCase(string?: string): string
  • Converts string to start case.

    Parameters

    • Optional string: string

      The string to convert.

    Returns string

    Returns the start cased string.

startsWith

  • startsWith(string?: string, target?: string, position?: number): boolean
  • Checks if string starts with the given target string.

    Parameters

    • Optional string: string

      The string to search.

    • Optional target: string

      The string to search for.

    • Optional position: number

      The position to search from.

    Returns boolean

    Returns true if string starts with target, else false.

sum

  • sum(collection: Array<number>): number
  • sum(collection: List<number>): number
  • sum(collection: Dictionary<number>): number
  • sum<T>(collection: Array<T>, iteratee: ListIterator<T, number>, thisArg?: any): number
  • sum<T>(collection: List<T>, iteratee: ListIterator<T, number>, thisArg?: any): number
  • sum<T>(collection: Dictionary<T>, iteratee: ObjectIterator<T, number>, thisArg?: any): number
  • sum<T>(collection: Array<T>, property: string): number
  • sum<T>(collection: List<T>, property: string): number
  • sum<T>(collection: Dictionary<T>, property: string): number
  • Gets the sum of the values in collection.

    Parameters

    • collection: Array<number>

      The collection to iterate over.

    Returns number

    Returns the sum.

  • see

    _.sum

    Parameters

    • collection: List<number>

    Returns number

  • see

    _.sum

    Parameters

    Returns number

  • see

    _.sum

    Type parameters

    • T

    Parameters

    • collection: Array<T>
    • iteratee: ListIterator<T, number>
    • Optional thisArg: any

    Returns number

  • see

    _.sum

    Type parameters

    • T

    Parameters

    Returns number

  • see

    _.sum

    Type parameters

    • T

    Parameters

    Returns number

  • see

    _.sum

    Type parameters

    • T

    Parameters

    • collection: Array<T>
    • property: string

      _.property callback shorthand.

    Returns number

  • see

    _.sum

    Type parameters

    • T

    Parameters

    • collection: List<T>
    • property: string

      _.property callback shorthand.

    Returns number

  • see

    _.sum

    Type parameters

    • T

    Parameters

    • collection: Dictionary<T>
    • property: string

      _.property callback shorthand.

    Returns number

tail

  • tail<T>(array: Array<T>): T[]
  • tail<T>(array: List<T>): T[]
  • tail<T>(array: Array<T>, callback: ListIterator<T, boolean>, thisArg?: any): T[]
  • tail<T>(array: List<T>, callback: ListIterator<T, boolean>, thisArg?: any): T[]
  • tail<T>(array: Array<T>, n: number): T[]
  • tail<T>(array: List<T>, n: number): T[]
  • tail<T>(array: Array<T>, pluckValue: string): T[]
  • tail<T>(array: List<T>, pluckValue: string): T[]
  • tail<W, T>(array: Array<T>, whereValue: W): T[]
  • tail<W, T>(array: List<T>, whereValue: W): T[]
  • see

    _.rest

    Type parameters

    • T

    Parameters

    • array: Array<T>

    Returns T[]

  • see

    _.rest

    Type parameters

    • T

    Parameters

    Returns T[]

  • see

    _.rest

    Type parameters

    • T

    Parameters

    • array: Array<T>
    • callback: ListIterator<T, boolean>
    • Optional thisArg: any

    Returns T[]

  • see

    _.rest

    Type parameters

    • T

    Parameters

    Returns T[]

  • see

    _.rest

    Type parameters

    • T

    Parameters

    • array: Array<T>
    • n: number

    Returns T[]

  • see

    _.rest

    Type parameters

    • T

    Parameters

    • array: List<T>
    • n: number

    Returns T[]

  • see

    _.rest

    Type parameters

    • T

    Parameters

    • array: Array<T>
    • pluckValue: string

    Returns T[]

  • see

    _.rest

    Type parameters

    • T

    Parameters

    • array: List<T>
    • pluckValue: string

    Returns T[]

  • see

    _.rest

    Type parameters

    • W

    • T

    Parameters

    • array: Array<T>
    • whereValue: W

    Returns T[]

  • see

    _.rest

    Type parameters

    • W

    • T

    Parameters

    • array: List<T>
    • whereValue: W

    Returns T[]

take

  • take<T>(array: Array<T>): T[]
  • take<T>(array: List<T>): T[]
  • take<T>(array: Array<T>, n: number): T[]
  • take<T>(array: List<T>, n: number): T[]
  • see

    _.first

    Type parameters

    • T

    Parameters

    • array: Array<T>

    Returns T[]

  • see

    _.first

    Type parameters

    • T

    Parameters

    Returns T[]

  • see

    _.first

    Type parameters

    • T

    Parameters

    • array: Array<T>
    • n: number

    Returns T[]

  • see

    _.first

    Type parameters

    • T

    Parameters

    • array: List<T>
    • n: number

    Returns T[]

takeWhile

  • takeWhile<T>(array: Array<T> | List<T>, predicate?: ListIterator<T, boolean>, thisArg?: any): T[]
  • takeWhile<T>(array: Array<T> | List<T>, pluckValue: string): any[]
  • takeWhile<W, T>(array: Array<T> | List<T>, whereValue: W): T[]
  • Takes the first items from an array or list based on a predicate

    Type parameters

    • T

    Parameters

    • array: Array<T> | List<T>

      The array or list of items on which the result set will be based

    • Optional predicate: ListIterator<T, boolean>

      A predicate function to determine whether a value will be taken. Optional; defaults to identity.

    • Optional thisArg: any

    Returns T[]

  • Takes the first items from an array or list based on a predicate

    Type parameters

    • T

    Parameters

    • array: Array<T> | List<T>

      The array or list of items on which the result set will be based

    • pluckValue: string

      Uses a _.property style callback to return the property value of the given element

    Returns any[]

  • Takes the first items from an array or list based on a predicate

    Type parameters

    • W

    • T

    Parameters

    • array: Array<T> | List<T>

      The array or list of items on which the result set will be based

    • whereValue: W

      Uses a _.matches style callback to return the first elements that match the given value

    Returns T[]

tap

  • tap<T>(value: T, interceptor: function): T
  • Invokes interceptor with the value as the first argument and then returns value. The purpose of this method is to "tap into" a method chain in order to perform operations on intermediate results within the chain.

    Type parameters

    • T

    Parameters

    • value: T

      The value to provide to interceptor

    • interceptor: function

      The function to invoke.

        • (value: T): void
        • Parameters

          • value: T

          Returns void

    Returns T

    value

template

  • Creates a compiled template function that can interpolate data properties in "interpolate" delimiters, HTML-escape interpolated data properties in "escape" delimiters, and execute JavaScript in "evaluate" delimiters. Data properties may be accessed as free variables in the template. If a setting object is provided it takes precedence over _.templateSettings values.

    Note: In the development build _.template utilizes sourceURLs for easier debugging.

    For more information on precompiling templates see lodash's custom builds documentation.

    For more information on Chrome extension sandboxes see Chrome's extensions documentation.

    Parameters

    • string: string

      The template string.

    • Optional options: TemplateSettings

      The options object.

    Returns TemplateExecutor

    Returns the compiled template function.

throttle

  • Creates a function that, when executed, will only call the func function at most once per every wait milliseconds. Provide an options object to indicate that func should be invoked on the leading and/or trailing edge of the wait timeout. Subsequent calls to the throttled function will return the result of the last func call.

    Note: If leading and trailing options are true func will be called on the trailing edge of the timeout only if the the throttled function is invoked more than once during the wait timeout.

    Type parameters

    • T: Function

    Parameters

    • func: T

      The function to throttle.

    • wait: number

      The number of milliseconds to throttle executions to.

    • Optional options: ThrottleSettings

      The options object.

    Returns T

    The new throttled function.

times

  • times<TResult>(n: number, iteratee: function, thisArg?: any): TResult[]
  • times(n: number): number[]
  • Invokes the iteratee function n times, returning an array of the results of each invocation. The iteratee is bound to thisArg and invoked with one argument; (index).

    Type parameters

    • TResult

    Parameters

    • n: number

      The number of times to invoke iteratee.

    • iteratee: function

      The function invoked per iteration.

        • (num: number): TResult
        • Parameters

          • num: number

          Returns TResult

    • Optional thisArg: any

      The this binding of iteratee.

    Returns TResult[]

    Returns the array of results.

  • see

    _.times

    Parameters

    • n: number

    Returns number[]

toArray

  • toArray<T>(collection: Array<T>): T[]
  • toArray<T>(collection: List<T>): T[]
  • toArray<T>(collection: Dictionary<T>): T[]
  • Converts the collection to an array.

    Type parameters

    • T

    Parameters

    • collection: Array<T>

      The collection to convert.

    Returns T[]

    The new converted array.

  • see

    _.toArray

    Type parameters

    • T

    Parameters

    • collection: List<T>

    Returns T[]

  • see

    _.toArray

    Type parameters

    • T

    Parameters

    Returns T[]

toPlainObject

  • toPlainObject(value?: any): Object
  • Converts value to a plain object flattening inherited enumerable properties of value to own properties of the plain object.

    Parameters

    • Optional value: any

      The value to convert.

    Returns Object

    Returns the converted plain object.

transform

  • transform<T, Acc>(collection: Array<T>, callback: MemoVoidIterator<T, Acc>, accumulator: Acc, thisArg?: any): Acc
  • transform<T, Acc>(collection: List<T>, callback: MemoVoidIterator<T, Acc>, accumulator: Acc, thisArg?: any): Acc
  • transform<T, Acc>(collection: Dictionary<T>, callback: MemoVoidIterator<T, Acc>, accumulator: Acc, thisArg?: any): Acc
  • transform<T, Acc>(collection: Array<T>, callback?: MemoVoidIterator<T, Acc>, thisArg?: any): Acc
  • transform<T, Acc>(collection: List<T>, callback?: MemoVoidIterator<T, Acc>, thisArg?: any): Acc
  • transform<T, Acc>(collection: Dictionary<T>, callback?: MemoVoidIterator<T, Acc>, thisArg?: any): Acc
  • An alternative to _.reduce this method transforms object to a new accumulator object which is the result of running each of its elements through a callback, with each callback execution potentially mutating the accumulator object. The callback is bound to thisArg and invoked with four arguments; (accumulator, value, key, object). Callbacks may exit iteration early by explicitly returning false.

    Type parameters

    • T

    • Acc

    Parameters

    • collection: Array<T>

      The collection to iterate over.

    • callback: MemoVoidIterator<T, Acc>

      The function called per iteration.

    • accumulator: Acc

      The custom accumulator value.

    • Optional thisArg: any

      The this binding of callback.

    Returns Acc

    The accumulated value.

  • see

    _.transform

    Type parameters

    • T

    • Acc

    Parameters

    Returns Acc

  • see

    _.transform

    Type parameters

    • T

    • Acc

    Parameters

    Returns Acc

  • see

    _.transform

    Type parameters

    • T

    • Acc

    Parameters

    • collection: Array<T>
    • Optional callback: MemoVoidIterator<T, Acc>
    • Optional thisArg: any

    Returns Acc

  • see

    _.transform

    Type parameters

    • T

    • Acc

    Parameters

    Returns Acc

  • see

    _.transform

    Type parameters

    • T

    • Acc

    Parameters

    Returns Acc

trim

  • trim(string?: string, chars?: string): string
  • Removes leading and trailing whitespace or specified characters from string.

    Parameters

    • Optional string: string

      The string to trim.

    • Optional chars: string

      The characters to trim.

    Returns string

    Returns the trimmed string.

trimLeft

  • trimLeft(string?: string, chars?: string): string
  • Removes leading whitespace or specified characters from string.

    Parameters

    • Optional string: string

      The string to trim.

    • Optional chars: string

      The characters to trim.

    Returns string

    Returns the trimmed string.

trimRight

  • trimRight(string?: string, chars?: string): string
  • Removes trailing whitespace or specified characters from string.

    Parameters

    • Optional string: string

      The string to trim.

    • Optional chars: string

      The characters to trim.

    Returns string

    Returns the trimmed string.

trunc

  • trunc(string?: string, options?: TruncOptions | number): string
  • Truncates string if it’s longer than the given maximum string length. The last characters of the truncated string are replaced with the omission string which defaults to "…".

    Parameters

    • Optional string: string

      The string to truncate.

    • Optional options: TruncOptions | number

      The options object or maximum string length.

    Returns string

    Returns the truncated string.

unescape

  • unescape(string?: string): string
  • The inverse of _.escape; this method converts the HTML entities &, <, >, ", ', and ` in string to their corresponding characters.

    Parameters

    • Optional string: string

      The string to unescape.

    Returns string

    Returns the unescaped string.

union

  • union<T>(...arrays: Array<T>[]): T[]
  • union<T>(...arrays: List<T>[]): T[]
  • Creates an array of unique values, in order, of the provided arrays using strict equality for comparisons, i.e. ===.

    Type parameters

    • T

    Parameters

    • Rest ...arrays: Array<T>[]

      The arrays to inspect.

    Returns T[]

    Returns an array of composite values.

  • see

    _.union

    Type parameters

    • T

    Parameters

    • Rest ...arrays: List<T>[]

    Returns T[]

uniq

  • uniq<T, TSort>(array: Array<T>, isSorted?: boolean): T[]
  • uniq<T, TSort>(array: List<T>, isSorted?: boolean): T[]
  • uniq<T, TSort>(array: Array<T>, isSorted: boolean, callback: ListIterator<T, TSort>, thisArg?: any): T[]
  • uniq<T, TSort>(array: List<T>, isSorted: boolean, callback: ListIterator<T, TSort>, thisArg?: any): T[]
  • uniq<T, TSort>(array: Array<T>, callback: ListIterator<T, TSort>, thisArg?: any): T[]
  • uniq<T, TSort>(array: List<T>, callback: ListIterator<T, TSort>, thisArg?: any): T[]
  • uniq<T>(array: Array<T>, isSorted: boolean, pluckValue: string): T[]
  • uniq<T>(array: List<T>, isSorted: boolean, pluckValue: string): T[]
  • uniq<T>(array: Array<T>, pluckValue: string): T[]
  • uniq<T>(array: List<T>, pluckValue: string): T[]
  • uniq<W, T>(array: Array<T>, isSorted: boolean, whereValue: W): T[]
  • uniq<W, T>(array: List<T>, isSorted: boolean, whereValue: W): T[]
  • uniq<W, T>(array: Array<T>, whereValue: W): T[]
  • uniq<W, T>(array: List<T>, whereValue: W): T[]
  • Creates a duplicate-value-free version of an array using strict equality for comparisons, i.e. ===. If the array is sorted, providing true for isSorted will use a faster algorithm. If a callback is provided each element of array is passed through the callback before uniqueness is computed. The callback is bound to thisArg and invoked with three arguments; (value, index, array).

    If a property name is provided for callback the created "_.pluck" style callback will return the property value of the given element.

    If an object is provided for callback the created "_.where" style callback will return true for elements that have the properties of the given object, else false.

    Type parameters

    • T

    • TSort

    Parameters

    • array: Array<T>

      Array to remove duplicates from.

    • Optional isSorted: boolean

      True if array is already sorted, optiona, default = false.

    Returns T[]

    Copy of array where all elements are unique.

  • see

    _.uniq

    Type parameters

    • T

    • TSort

    Parameters

    • array: List<T>
    • Optional isSorted: boolean

    Returns T[]

  • see

    _.uniq

    Type parameters

    • T

    • TSort

    Parameters

    • array: Array<T>
    • isSorted: boolean
    • callback: ListIterator<T, TSort>
    • Optional thisArg: any

    Returns T[]

  • see

    _.uniq

    Type parameters

    • T

    • TSort

    Parameters

    • array: List<T>
    • isSorted: boolean
    • callback: ListIterator<T, TSort>
    • Optional thisArg: any

    Returns T[]

  • see

    _.uniq

    Type parameters

    • T

    • TSort

    Parameters

    • array: Array<T>
    • callback: ListIterator<T, TSort>
    • Optional thisArg: any

    Returns T[]

  • see

    _.uniq

    Type parameters

    • T

    • TSort

    Parameters

    Returns T[]

  • see

    _.uniq

    Type parameters

    • T

    Parameters

    • array: Array<T>
    • isSorted: boolean
    • pluckValue: string

      _.pluck style callback

    Returns T[]

  • see

    _.uniq

    Type parameters

    • T

    Parameters

    • array: List<T>
    • isSorted: boolean
    • pluckValue: string

      _.pluck style callback

    Returns T[]

  • see

    _.uniq

    Type parameters

    • T

    Parameters

    • array: Array<T>
    • pluckValue: string

      _.pluck style callback

    Returns T[]

  • see

    _.uniq

    Type parameters

    • T

    Parameters

    • array: List<T>
    • pluckValue: string

      _.pluck style callback

    Returns T[]

  • see

    _.uniq

    Type parameters

    • W

    • T

    Parameters

    • array: Array<T>
    • isSorted: boolean
    • whereValue: W

      _.where style callback

    Returns T[]

  • see

    _.uniq

    Type parameters

    • W

    • T

    Parameters

    • array: List<T>
    • isSorted: boolean
    • whereValue: W

      _.where style callback

    Returns T[]

  • see

    _.uniq

    Type parameters

    • W

    • T

    Parameters

    • array: Array<T>
    • whereValue: W

      _.where style callback

    Returns T[]

  • see

    _.uniq

    Type parameters

    • W

    • T

    Parameters

    • array: List<T>
    • whereValue: W

      _.where style callback

    Returns T[]

unique

  • unique<T>(array: Array<T>, isSorted?: boolean): T[]
  • unique<T>(array: List<T>, isSorted?: boolean): T[]
  • unique<T, TSort>(array: Array<T>, callback: ListIterator<T, TSort>, thisArg?: any): T[]
  • unique<T, TSort>(array: List<T>, callback: ListIterator<T, TSort>, thisArg?: any): T[]
  • unique<T, TSort>(array: Array<T>, isSorted: boolean, callback: ListIterator<T, TSort>, thisArg?: any): T[]
  • unique<T, TSort>(array: List<T>, isSorted: boolean, callback: ListIterator<T, TSort>, thisArg?: any): T[]
  • unique<T>(array: Array<T>, isSorted: boolean, pluckValue: string): T[]
  • unique<T>(array: List<T>, isSorted: boolean, pluckValue: string): T[]
  • unique<T>(array: Array<T>, pluckValue: string): T[]
  • unique<T>(array: List<T>, pluckValue: string): T[]
  • unique<W, T>(array: Array<T>, whereValue?: W): T[]
  • unique<W, T>(array: List<T>, whereValue?: W): T[]
  • unique<W, T>(array: Array<T>, isSorted: boolean, whereValue?: W): T[]
  • unique<W, T>(array: List<T>, isSorted: boolean, whereValue?: W): T[]
  • see

    _.uniq

    Type parameters

    • T

    Parameters

    • array: Array<T>
    • Optional isSorted: boolean

    Returns T[]

  • see

    _.uniq

    Type parameters

    • T

    Parameters

    • array: List<T>
    • Optional isSorted: boolean

    Returns T[]

  • see

    _.uniq

    Type parameters

    • T

    • TSort

    Parameters

    • array: Array<T>
    • callback: ListIterator<T, TSort>
    • Optional thisArg: any

    Returns T[]

  • see

    _.uniq

    Type parameters

    • T

    • TSort

    Parameters

    Returns T[]

  • see

    _.uniq

    Type parameters

    • T

    • TSort

    Parameters

    • array: Array<T>
    • isSorted: boolean
    • callback: ListIterator<T, TSort>
    • Optional thisArg: any

    Returns T[]

  • see

    _.uniq

    Type parameters

    • T

    • TSort

    Parameters

    • array: List<T>
    • isSorted: boolean
    • callback: ListIterator<T, TSort>
    • Optional thisArg: any

    Returns T[]

  • see

    _.uniq

    Type parameters

    • T

    Parameters

    • array: Array<T>
    • isSorted: boolean
    • pluckValue: string

      _.pluck style callback

    Returns T[]

  • see

    _.uniq

    Type parameters

    • T

    Parameters

    • array: List<T>
    • isSorted: boolean
    • pluckValue: string

      _.pluck style callback

    Returns T[]

  • see

    _.uniq

    Type parameters

    • T

    Parameters

    • array: Array<T>
    • pluckValue: string

      _.pluck style callback

    Returns T[]

  • see

    _.uniq

    Type parameters

    • T

    Parameters

    • array: List<T>
    • pluckValue: string

      _.pluck style callback

    Returns T[]

  • see

    _.uniq

    Type parameters

    • W

    • T

    Parameters

    • array: Array<T>
    • Optional whereValue: W

      _.where style callback

    Returns T[]

  • see

    _.uniq

    Type parameters

    • W

    • T

    Parameters

    • array: List<T>
    • Optional whereValue: W

      _.where style callback

    Returns T[]

  • see

    _.uniq

    Type parameters

    • W

    • T

    Parameters

    • array: Array<T>
    • isSorted: boolean
    • Optional whereValue: W

      _.where style callback

    Returns T[]

  • see

    _.uniq

    Type parameters

    • W

    • T

    Parameters

    • array: List<T>
    • isSorted: boolean
    • Optional whereValue: W

      _.where style callback

    Returns T[]

uniqueId

  • uniqueId(prefix?: string): string
  • Generates a unique ID. If prefix is provided the ID is appended to it.

    Parameters

    • Optional prefix: string

      The value to prefix the ID with.

    Returns string

    Returns the unique ID.

unzip

  • unzip(...arrays: any[]): any[]
  • unzip(...arrays: any[]): any[]
  • see

    _.zip

    Parameters

    • Rest ...arrays: any[]

    Returns any[]

  • see

    _.zip

    Parameters

    • Rest ...arrays: any[]

    Returns any[]

values

  • values<T>(object?: any): T[]
  • Creates an array of the own enumerable property values of object.

    Type parameters

    • T

    Parameters

    • Optional object: any

      The object to query.

    Returns T[]

    Returns an array of property values.

valuesIn

  • valuesIn<T>(object?: any): T[]
  • Creates an array of the own and inherited enumerable property values of object.

    Type parameters

    • T

    Parameters

    • Optional object: any

      The object to query.

    Returns T[]

    Returns the array of property values.

where

  • where<T, U>(list: Array<T>, properties: U): T[]
  • where<T, U>(list: List<T>, properties: U): T[]
  • where<T, U>(list: Dictionary<T>, properties: U): T[]
  • Performs a deep comparison of each element in a collection to the given properties object, returning an array of all elements that have equivalent property values.

    Type parameters

    • T

    • U: object

    Parameters

    • list: Array<T>
    • properties: U

      The object of property values to filter by.

    Returns T[]

    A new array of elements that have the given properties.

  • see

    _.where

    Type parameters

    • T

    • U: object

    Parameters

    • list: List<T>
    • properties: U

    Returns T[]

  • see

    _.where

    Type parameters

    • T

    • U: object

    Parameters

    Returns T[]

without

  • without<T>(array: Array<T>, ...values: T[]): T[]
  • without<T>(array: List<T>, ...values: T[]): T[]
  • Creates an array excluding all provided values using strict equality for comparisons, i.e. ===.

    Type parameters

    • T

    Parameters

    • array: Array<T>

      The array to filter.

    • Rest ...values: T[]

      The value(s) to exclude.

    Returns T[]

    A new array of filtered values.

  • see

    _.without

    Type parameters

    • T

    Parameters

    • array: List<T>
    • Rest ...values: T[]

    Returns T[]

words

  • words(string?: string, pattern?: string | RegExp): string[]
  • Splits string into an array of its words.

    Parameters

    • Optional string: string

      The string to inspect.

    • Optional pattern: string | RegExp

      The pattern to match words.

    Returns string[]

    Returns the words of string.

wrap

  • wrap(value: any, wrapper: function): Function
  • Creates a function that provides value to the wrapper function as its first argument. Additional arguments provided to the function are appended to those provided to the wrapper function. The wrapper is executed with the this binding of the created function.

    Parameters

    • value: any

      The value to wrap.

    • wrapper: function

      The wrapper function.

        • (func: Function, ...args: any[]): any
        • Parameters

          • func: Function
          • Rest ...args: any[]

          Returns any

    Returns Function

    The new function.

xor

  • xor<T>(...arrays: List<T>[]): T[]
  • Creates an array of unique values that is the symmetric difference of the provided arrays.

    Type parameters

    • T

    Parameters

    • Rest ...arrays: List<T>[]

      The arrays to inspect.

    Returns T[]

    Returns the new array of values.

zip

  • zip(...arrays: any[]): any[]
  • zip(...arrays: any[]): any[]
  • Creates an array of grouped elements, the first of which contains the first elements of the given arrays, the second of which contains the second elements of the given arrays, and so on.

    Parameters

    • Rest ...arrays: any[]

      Arrays to process.

    Returns any[]

    A new array of grouped elements.

  • see

    _.zip

    Parameters

    • Rest ...arrays: any[]

    Returns any[]

zipObject

  • zipObject<TResult>(props: List<string>, values?: List<any>): TResult
  • zipObject<TResult>(props: List<List<any>>): Dictionary<any>
  • The inverse of _.pairs; this method returns an object composed from arrays of property names and values. Provide either a single two dimensional array, e.g. [[key1, value1], [key2, value2]] or two arrays, one of property names and one of corresponding values.

    Type parameters

    • TResult: object

    Parameters

    • props: List<string>

      The property names.

    • Optional values: List<any>

      The property values.

    Returns TResult

    Returns the new object.

  • see

    _.zipObject

    Type parameters

    • TResult: object

    Parameters

    Returns Dictionary<any>

zipWith

  • zipWith<TResult>(...args: any[]): TResult[]
  • This method is like _.zip except that it accepts an iteratee to specify how grouped values should be combined. The iteratee is bound to thisArg and invoked with four arguments: (accumulator, value, index, group).

    Type parameters

    • TResult

    Parameters

    • Rest ...args: any[]

    Returns TResult[]

    Returns the new array of grouped elements.

LoDashStringWrapper

LoDashStringWrapper:

add

  • add(addend: number): number
  • see

    _.add

    Parameters

    • addend: number

    Returns number

after

before

  • before<TFunc>(func: TFunc): TFunc
  • sed

    _.before

    Type parameters

    • TFunc: Function

    Parameters

    • func: TFunc

    Returns TFunc

camelCase

  • camelCase(): string
  • see

    _.camelCase

    Returns string

capitalize

  • capitalize(): string
  • see

    _.capitalize

    Returns string

ceil

  • ceil(precision?: number): number
  • see

    _.ceil

    Parameters

    • Optional precision: number

    Returns number

clone

  • clone(isDeep?: boolean, customizer?: function, thisArg?: any): string
  • clone(customizer?: function, thisArg?: any): string
  • see

    _.clone

    Parameters

    • Optional isDeep: boolean
    • Optional customizer: function
        • (value: any): any
        • Parameters

          • value: any

          Returns any

    • Optional thisArg: any

    Returns string

  • see

    _.clone

    Parameters

    • Optional customizer: function
        • (value: any): any
        • Parameters

          • value: any

          Returns any

    • Optional thisArg: any

    Returns string

cloneDeep

  • cloneDeep(customizer?: function, thisArg?: any): string
  • see

    _.cloneDeep

    Parameters

    • Optional customizer: function
        • (value: any): any
        • Parameters

          • value: any

          Returns any

    • Optional thisArg: any

    Returns string

contains

  • contains(target: string, fromIndex?: number): boolean
  • see

    _.contains

    Parameters

    • target: string
    • Optional fromIndex: number

    Returns boolean

createCallback

deburr

  • deburr(): string
  • see

    _.deburr

    Returns string

endsWith

  • endsWith(target?: string, position?: number): boolean
  • see

    _.endsWith

    Parameters

    • Optional target: string
    • Optional position: number

    Returns boolean

eq

  • eq(other?: any, callback?: EqCustomizer, thisArg?: any): boolean
  • see

    _.isEqual

    Parameters

    • Optional other: any
    • Optional callback: EqCustomizer
    • Optional thisArg: any

    Returns boolean

escape

  • escape(): string
  • see

    _.escape

    Returns string

escapeRegExp

  • escapeRegExp(): string
  • see

    _.escapeRegExp

    Returns string

floor

  • floor(precision?: number): number
  • see

    _.floor

    Parameters

    • Optional precision: number

    Returns number

identity

  • identity(): string
  • see

    _.identity

    Returns string

inRange

  • inRange(start: number, end: number): boolean
  • inRange(end: number): boolean
  • see

    _.inRange

    Parameters

    • start: number
    • end: number

    Returns boolean

  • see

    _.inRange

    Parameters

    • end: number

    Returns boolean

include

  • include(target: string, fromIndex?: number): boolean
  • see

    _.contains

    Parameters

    • target: string
    • Optional fromIndex: number

    Returns boolean

includes

  • includes(target: string, fromIndex?: number): boolean
  • see

    _.contains

    Parameters

    • target: string
    • Optional fromIndex: number

    Returns boolean

isEqual

  • isEqual(other?: any, callback?: EqCustomizer, thisArg?: any): boolean
  • see

    _.isEqual

    Parameters

    • Optional other: any
    • Optional callback: EqCustomizer
    • Optional thisArg: any

    Returns boolean

kebabCase

  • kebabCase(): string
  • see

    _.kebabCase

    Returns string

method

  • see

    _.method

    Type parameters

    • TResult

    Parameters

    • Rest ...args: any[]

    Returns LoDashWrapper<function>

  • see

    _.method

    Type parameters

    • TResult

    Parameters

    • Rest ...args: any[]

    Returns LoDashWrapper<function>

pad

  • pad(length?: number, chars?: string): string
  • see

    _.pad

    Parameters

    • Optional length: number
    • Optional chars: string

    Returns string

padLeft

  • padLeft(length?: number, chars?: string): string
  • see

    _.padLeft

    Parameters

    • Optional length: number
    • Optional chars: string

    Returns string

padRight

  • padRight(length?: number, chars?: string): string
  • see

    _.padRight

    Parameters

    • Optional length: number
    • Optional chars: string

    Returns string

parseInt

  • parseInt(radix?: number): number
  • see

    _.parseInt

    Parameters

    • Optional radix: number

    Returns number

partition

  • see

    _.partition

    Parameters

    • callback: ListIterator<string, boolean>
    • Optional thisArg: any

    Returns LoDashArrayWrapper<string[]>

property

  • see

    _.property

    Type parameters

    • TObj

    • TResult

    Returns LoDashObjectWrapper<function>

range

  • see

    _.range

    Parameters

    • Optional end: number
    • Optional step: number

    Returns LoDashArrayWrapper<number>

repeat

  • repeat(n?: number): string
  • see

    _.repeat

    Parameters

    • Optional n: number

    Returns string

round

  • round(precision?: number): number
  • see

    _.round

    Parameters

    • Optional precision: number

    Returns number

run

  • run(): string
  • see

    _.value

    Returns string

snakeCase

  • snakeCase(): string
  • see

    _.snakeCase

    Returns string

startCase

  • startCase(): string
  • see

    _.startCase

    Returns string

startsWith

  • startsWith(target?: string, position?: number): boolean
  • see

    _.startsWith

    Parameters

    • Optional target: string
    • Optional position: number

    Returns boolean

template

times

  • see

    _.times

    Type parameters

    • TResult

    Parameters

    • iteratee: function
        • (num: number): TResult
        • Parameters

          • num: number

          Returns TResult

    • Optional thisArgs: any

    Returns LoDashArrayWrapper<TResult>

  • see

    _.times

    Returns LoDashArrayWrapper<number>

toJSON

  • toJSON(): string
  • see

    _.value

    Returns string

toPlainObject

  • toPlainObject(): Object

toString

  • toString(): string
  • Produces the toString result of the wrapped value.

    Returns string

    Returns the string result.

trim

  • trim(chars?: string): string
  • see

    _.trim

    Parameters

    • Optional chars: string

    Returns string

trimLeft

  • trimLeft(chars?: string): string
  • see

    _.trimLeft

    Parameters

    • Optional chars: string

    Returns string

trimRight

  • trimRight(chars?: string): string
  • see

    _.trimRight

    Parameters

    • Optional chars: string

    Returns string

trunc

  • see

    _.trunc

    Parameters

    Returns string

unescape

  • unescape(): string
  • see

    _.unescape

    Returns string

uniqueId

  • uniqueId(): string
  • see

    _.uniqueId

    Returns string

value

  • value(): string
  • Executes the chained sequence to extract the unwrapped value.

    Returns string

    Returns the resolved unwrapped value.

valueOf

  • valueOf(): string
  • see

    _.value

    Returns string

words

  • words(pattern?: string | RegExp): string[]
  • see

    _.words

    Parameters

    • Optional pattern: string | RegExp

    Returns string[]

LoDashWrapper

LoDashWrapper:

add

  • add(addend: number): number
  • see

    _.add

    Parameters

    • addend: number

    Returns number

after

  • see

    _.after

    Parameters

    • func: Function

    Returns LoDashObjectWrapper<Function>

before

  • before<TFunc>(func: TFunc): TFunc
  • sed

    _.before

    Type parameters

    • TFunc: Function

    Parameters

    • func: TFunc

    Returns TFunc

camelCase

  • camelCase(): string
  • see

    _.camelCase

    Returns string

capitalize

  • capitalize(): string
  • see

    _.capitalize

    Returns string

ceil

  • ceil(precision?: number): number
  • see

    _.ceil

    Parameters

    • Optional precision: number

    Returns number

chain

  • Enables explicit method chaining on the wrapper object.

    see

    _.chain

    Returns LoDashWrapper<T>

    The wrapper object.

clone

  • clone(isDeep?: boolean, customizer?: function, thisArg?: any): T
  • clone(customizer?: function, thisArg?: any): T
  • see

    _.clone

    Parameters

    • Optional isDeep: boolean
    • Optional customizer: function
        • (value: any): any
        • Parameters

          • value: any

          Returns any

    • Optional thisArg: any

    Returns T

  • see

    _.clone

    Parameters

    • Optional customizer: function
        • (value: any): any
        • Parameters

          • value: any

          Returns any

    • Optional thisArg: any

    Returns T

cloneDeep

  • cloneDeep(customizer?: function, thisArg?: any): T
  • see

    _.cloneDeep

    Parameters

    • Optional customizer: function
        • (value: any): any
        • Parameters

          • value: any

          Returns any

    • Optional thisArg: any

    Returns T

constant

  • constant<TResult>(): function
  • see

    _.constant

    Type parameters

    • TResult

    Returns function

      • (): TResult
      • Returns TResult

createCallback

  • see

    _.createCallback

    Parameters

    • Optional thisArg: any
    • Optional argCount: number

    Returns LoDashObjectWrapper<function>

deburr

  • deburr(): string
  • see

    _.deburr

    Returns string

endsWith

  • endsWith(target?: string, position?: number): boolean
  • see

    _.endsWith

    Parameters

    • Optional target: string
    • Optional position: number

    Returns boolean

eq

  • eq(other?: any, callback?: EqCustomizer, thisArg?: any): boolean
  • see

    _.isEqual

    Parameters

    • Optional other: any
    • Optional callback: EqCustomizer
    • Optional thisArg: any

    Returns boolean

escape

  • escape(): string
  • see

    _.escape

    Returns string

escapeRegExp

  • escapeRegExp(): string
  • see

    _.escapeRegExp

    Returns string

floor

  • floor(precision?: number): number
  • see

    _.floor

    Parameters

    • Optional precision: number

    Returns number

gt

  • gt(other: any): boolean
  • see

    _.gt

    Parameters

    • other: any

    Returns boolean

gte

  • gte(other: any): boolean
  • see

    _.gte

    Parameters

    • other: any

    Returns boolean

identity

  • identity(): T
  • see

    _.identity

    Returns T

inRange

  • inRange(start: number, end: number): boolean
  • inRange(end: number): boolean
  • see

    _.inRange

    Parameters

    • start: number
    • end: number

    Returns boolean

  • see

    _.inRange

    Parameters

    • end: number

    Returns boolean

isArguments

  • isArguments(): boolean

isArray

  • isArray(): boolean
  • see

    _.isArray

    Returns boolean

isBoolean

  • isBoolean(): boolean
  • see

    _.isBoolean

    Returns boolean

isDate

  • isDate(): boolean
  • see

    _.isDate

    Returns boolean

isElement

  • isElement(): boolean
  • see

    _.isElement

    Returns boolean

isEmpty

  • isEmpty(): boolean
  • see

    _.isEmpty

    Returns boolean

isEqual

  • isEqual(other?: any, callback?: EqCustomizer, thisArg?: any): boolean
  • see

    _.isEqual

    Parameters

    • Optional other: any
    • Optional callback: EqCustomizer
    • Optional thisArg: any

    Returns boolean

isError

  • isError(): boolean
  • see

    _.isError

    Returns boolean

isFinite

  • isFinite(): boolean
  • see

    _.isFinite

    Returns boolean

isFunction

  • isFunction(): boolean

isNaN

  • isNaN(): boolean
  • see

    _.isNaN

    Returns boolean

isNative

  • isNative(): boolean
  • see _.isNative

    Returns boolean

isNull

  • isNull(): boolean
  • see _.isNull

    Returns boolean

isNumber

  • isNumber(): boolean
  • see _.isNumber

    Returns boolean

isObject

  • isObject(): boolean
  • see _.isObject

    Returns boolean

isPlainObject

  • isPlainObject(): boolean

isRegExp

  • isRegExp(): boolean
  • see _.isRegExp

    Returns boolean

isString

  • isString(): boolean
  • see _.isString

    Returns boolean

isTypedArray

  • isTypedArray(): boolean

isUndefined

  • isUndefined(): boolean

kebabCase

  • kebabCase(): string
  • see

    _.kebabCase

    Returns string

lt

  • lt(other: any): boolean
  • see

    _.lt

    Parameters

    • other: any

    Returns boolean

lte

  • lte(other: any): boolean
  • see

    _.lte

    Parameters

    • other: any

    Returns boolean

method

  • see

    _.method

    Type parameters

    • TResult

    Parameters

    • Rest ...args: any[]

    Returns LoDashWrapper<function>

  • see

    _.method

    Type parameters

    • TResult

    Parameters

    • Rest ...args: any[]

    Returns LoDashWrapper<function>

noop

  • noop(...args: any[]): void
  • see

    _.noop

    Parameters

    • Rest ...args: any[]

    Returns void

pad

  • pad(length?: number, chars?: string): string
  • see

    _.pad

    Parameters

    • Optional length: number
    • Optional chars: string

    Returns string

padLeft

  • padLeft(length?: number, chars?: string): string
  • see

    _.padLeft

    Parameters

    • Optional length: number
    • Optional chars: string

    Returns string

padRight

  • padRight(length?: number, chars?: string): string
  • see

    _.padRight

    Parameters

    • Optional length: number
    • Optional chars: string

    Returns string

parseInt

  • parseInt(radix?: number): number
  • see

    _.parseInt

    Parameters

    • Optional radix: number

    Returns number

range

  • see

    _.range

    Parameters

    • Optional end: number
    • Optional step: number

    Returns LoDashArrayWrapper<number>

repeat

  • repeat(n?: number): string
  • see

    _.repeat

    Parameters

    • Optional n: number

    Returns string

round

  • round(precision?: number): number
  • see

    _.round

    Parameters

    • Optional precision: number

    Returns number

run

  • run(): T
  • see

    _.value

    Returns T

snakeCase

  • snakeCase(): string
  • see

    _.snakeCase

    Returns string

startCase

  • startCase(): string
  • see

    _.startCase

    Returns string

startsWith

  • startsWith(target?: string, position?: number): boolean
  • see

    _.startsWith

    Parameters

    • Optional target: string
    • Optional position: number

    Returns boolean

tap

  • see

    _.tap

    Parameters

    • interceptor: function
        • (value: T): void
        • Parameters

          • value: T

          Returns void

    Returns LoDashWrapper<T>

template

times

  • see

    _.times

    Type parameters

    • TResult

    Parameters

    • iteratee: function
        • (num: number): TResult
        • Parameters

          • num: number

          Returns TResult

    • Optional thisArgs: any

    Returns LoDashArrayWrapper<TResult>

  • see

    _.times

    Returns LoDashArrayWrapper<number>

toJSON

  • toJSON(): T
  • see

    _.value

    Returns T

toPlainObject

  • toPlainObject(): Object

toString

  • toString(): string
  • Produces the toString result of the wrapped value.

    Returns string

    Returns the string result.

trim

  • trim(chars?: string): string
  • see

    _.trim

    Parameters

    • Optional chars: string

    Returns string

trimLeft

  • trimLeft(chars?: string): string
  • see

    _.trimLeft

    Parameters

    • Optional chars: string

    Returns string

trimRight

  • trimRight(chars?: string): string
  • see

    _.trimRight

    Parameters

    • Optional chars: string

    Returns string

trunc

  • see

    _.trunc

    Parameters

    Returns string

unescape

  • unescape(): string
  • see

    _.unescape

    Returns string

uniqueId

  • uniqueId(): string
  • see

    _.uniqueId

    Returns string

value

  • value(): T
  • Executes the chained sequence to extract the unwrapped value.

    Returns T

    Returns the resolved unwrapped value.

valueOf

  • valueOf(): T

words

  • words(pattern?: string | RegExp): string[]
  • see

    _.words

    Parameters

    • Optional pattern: string | RegExp

    Returns string[]

LoDashWrapperBase

LoDashWrapperBase:

chain

  • chain(): TWrapper
  • Enables explicit method chaining on the wrapper object.

    see

    _.chain

    Returns TWrapper

    The wrapper object.

constant

  • constant<TResult>(): function
  • see

    _.constant

    Type parameters

    • TResult

    Returns function

      • (): TResult
      • Returns TResult

gt

  • gt(other: any): boolean
  • see

    _.gt

    Parameters

    • other: any

    Returns boolean

gte

  • gte(other: any): boolean
  • see

    _.gte

    Parameters

    • other: any

    Returns boolean

isArguments

  • isArguments(): boolean
  • see

    _.isArguments

    Returns boolean

isArray

  • isArray(): boolean
  • see

    _.isArray

    Returns boolean

isBoolean

  • isBoolean(): boolean
  • see

    _.isBoolean

    Returns boolean

isDate

  • isDate(): boolean
  • see

    _.isDate

    Returns boolean

isElement

  • isElement(): boolean
  • see

    _.isElement

    Returns boolean

isEmpty

  • isEmpty(): boolean
  • see

    _.isEmpty

    Returns boolean

isError

  • isError(): boolean
  • see

    _.isError

    Returns boolean

isFinite

  • isFinite(): boolean
  • see

    _.isFinite

    Returns boolean

isFunction

  • isFunction(): boolean
  • see

    _.isFunction

    Returns boolean

isNaN

  • isNaN(): boolean
  • see

    _.isNaN

    Returns boolean

isNative

  • isNative(): boolean
  • see _.isNative

    Returns boolean

isNull

  • isNull(): boolean
  • see _.isNull

    Returns boolean

isNumber

  • isNumber(): boolean
  • see _.isNumber

    Returns boolean

isObject

  • isObject(): boolean
  • see _.isObject

    Returns boolean

isPlainObject

  • isPlainObject(): boolean
  • see _.isPlainObject

    Returns boolean

isRegExp

  • isRegExp(): boolean
  • see _.isRegExp

    Returns boolean

isString

  • isString(): boolean
  • see _.isString

    Returns boolean

isTypedArray

  • isTypedArray(): boolean
  • see _.isTypedArray

    Returns boolean

isUndefined

  • isUndefined(): boolean
  • see _.isUndefined

    Returns boolean

lt

  • lt(other: any): boolean
  • see

    _.lt

    Parameters

    • other: any

    Returns boolean

lte

  • lte(other: any): boolean
  • see

    _.lte

    Parameters

    • other: any

    Returns boolean

noop

  • noop(...args: any[]): void
  • see

    _.noop

    Parameters

    • Rest ...args: any[]

    Returns void

run

  • run(): T
  • see

    _.value

    Returns T

tap

  • tap(interceptor: function): TWrapper
  • see

    _.tap

    Parameters

    • interceptor: function
        • (value: T): void
        • Parameters

          • value: T

          Returns void

    Returns TWrapper

toJSON

  • toJSON(): T
  • see

    _.value

    Returns T

toPlainObject

  • toPlainObject(): Object
  • see

    _.toPlainObject

    Returns Object

toString

  • toString(): string
  • Produces the toString result of the wrapped value.

    Returns string

    Returns the string result.

value

  • value(): T
  • Executes the chained sequence to extract the unwrapped value.

    Returns T

    Returns the resolved unwrapped value.

valueOf

  • valueOf(): T
  • see

    _.value

    Returns T

MapCache

MapCache:

Creates a cache object to store key/value pairs.

delete

  • delete(key: string): boolean
  • Removes key and its value from the cache.

    Parameters

    • key: string

      The key of the value to remove.

    Returns boolean

    Returns true if the entry was removed successfully, else false.

get

  • get(key: string): any
  • Gets the cached value for key.

    Parameters

    • key: string

      The key of the value to get.

    Returns any

    Returns the cached value.

has

  • has(key: string): boolean
  • Checks if a cached value for key exists.

    Parameters

    • key: string

      The key of the entry to check.

    Returns boolean

    Returns true if an entry for key exists, else false.

set

  • Sets value to key of the cache.

    Parameters

    • key: string

      The key of the value to cache.

    • value: any

      The value to cache.

    Returns Dictionary<any>

    Returns the cache object.

MaybeNestedList

MaybeNestedList:

length

length: number

MemoIterator

  • __call(prev: TResult, curr: T, indexOrKey: any, list?: T[]): TResult
  • Parameters

    • prev: TResult
    • curr: T
    • indexOrKey: any
    • Optional list: T[]

    Returns TResult

MemoVoidIterator

  • __call(prev: TResult, curr: T, indexOrKey: any, list?: T[]): void
  • Parameters

    • prev: TResult
    • curr: T
    • indexOrKey: any
    • Optional list: T[]

    Returns void

MemoizedFunction

MemoizedFunction:

Function

Function: FunctionConstructor

arguments

arguments: any

cache

cache: MapCache

caller

caller: Function

length

length: number

prototype

prototype: any

apply

  • apply(thisArg: any, argArray?: any): any
  • Calls the function, substituting the specified object for the this value of the function, and the specified array for the arguments of the function.

    Parameters

    • thisArg: any

      The object to be used as the this object.

    • Optional argArray: any

      A set of arguments to be passed to the function.

    Returns any

bind

  • bind(thisArg: any, ...argArray: any[]): any
  • For a given function, creates a bound function that has the same body as the original function. The this object of the bound function is associated with the specified object, and has the specified initial parameters.

    Parameters

    • thisArg: any

      An object to which the this keyword can refer inside the new function.

    • Rest ...argArray: any[]

      A list of arguments to be passed to the new function.

    Returns any

call

  • call(thisArg: any, ...argArray: any[]): any
  • Calls a method of an object, substituting another object for the current object.

    Parameters

    • thisArg: any

      The object to be used as the current object.

    • Rest ...argArray: any[]

      A list of arguments to be passed to the method.

    Returns any

ObjectIterator

  • __call(element: T, key: string, collection: any): TResult
  • Parameters

    • element: T
    • key: string
    • collection: any

    Returns TResult

RecursiveList

RecursiveList:

length

length: number

Support

Support:

An object used to flag environments features.

argsClass

argsClass: boolean

Detect if an arguments object's Class is resolvable (all but Firefox < 4, IE < 9).

argsObject

argsObject: boolean

Detect if arguments objects are Object objects (all but Narwhal and Opera < 10.5).

enumErrorProps

enumErrorProps: boolean

Detect if name or message properties of Error.prototype are enumerable by default. (IE < 9, Safari < 5.1)

enumPrototypes

enumPrototypes: boolean

Detect if prototype properties are enumerable by default.

Firefox < 3.6, Opera > 9.50 - Opera < 11.60, and Safari < 5.1 (if the prototype or a property on the prototype has been set) incorrectly set the [[Enumerable]] value of a function’s prototype property to true.

fastBind

fastBind: boolean

Detect if Function#bind exists and is inferred to be fast (all but V8).

funcDecomp

funcDecomp: boolean

Detect if functions can be decompiled by Function#toString (all but PS3 and older Opera mobile browsers & avoided in Windows 8 apps).

funcNames

funcNames: boolean

Detect if Function#name is supported (all but IE).

nonEnumArgs

nonEnumArgs: boolean

Detect if arguments object indexes are non-enumerable (Firefox < 4, IE < 9, PhantomJS, Safari < 5.1).

nonEnumShadows

nonEnumShadows: boolean

Detect if properties shadowing those on Object.prototype are non-enumerable.

In IE < 9 an objects own properties, shadowing non-enumerable ones, are made non-enumerable as well (a.k.a the JScript [[DontEnum]] bug).

ownLast

ownLast: boolean

Detect if own properties are iterated after inherited properties (all but IE < 9).

spliceObjects

spliceObjects: boolean

Detect if Array#shift and Array#splice augment array-like objects correctly.

Firefox < 10, IE compatibility mode, and IE < 9 have buggy Array shift() and splice() functions that fail to remove the last element, value[0], of array-like objects even though the length property is set to 0. The shift() method is buggy in IE 8 compatibility mode, while splice() is buggy regardless of mode in IE < 9 and buggy in compatibility mode in IE 9.

unindexedChars

unindexedChars: boolean

Detect lack of support for accessing string characters by index.

IE < 8 can't access characters by index and IE 8 can only access characters by index on string literals.

TemplateExecutor

  • __call(data?: Object): string
  • Parameters

    • Optional data: Object

    Returns string

source

source: string

TemplateSettings

TemplateSettings:

By default, the template delimiters used by Lo-Dash are similar to those in embedded Ruby (ERB). Change the following template settings to use alternative delimiters.

escape

escape: RegExp

The "escape" delimiter.

evaluate

evaluate: RegExp

The "evaluate" delimiter.

imports

imports: Dictionary<any>

An object to import into the template as local variables.

interpolate

interpolate: RegExp

The "interpolate" delimiter.

variable

variable: string

Used to reference the data object in the template text.

ThrottleSettings

ThrottleSettings:

leading

leading: boolean

If you'd like to disable the leading-edge call, pass this as false.

trailing

trailing: boolean

If you'd like to disable the execution on the trailing-edge, pass false.

TruncOptions

TruncOptions:

length

length: number

The maximum string length.

omission

omission: string

The string to indicate text is omitted.

separator

separator: string | RegExp

The separator pattern to truncate to.

isMatchCustomizer

  • __call(value: any, other: any, indexOrKey?: number | string): boolean
  • Parameters

    • value: any
    • other: any
    • Optional indexOrKey: number | string

    Returns boolean

"typings/main/ambient/magic-string/index.d"

"typings/main/ambient/magic-string/index.d":

"magic-string"

"magic-string":

Bundle

Bundle:

constructor

  • Parameters

    Returns Bundle

addSource

append

  • append(string: string, options?: object): Bundle
  • Parameters

    • string: string
    • Optional options: object
      • Optional seperator?: string

    Returns Bundle

clone

  • Returns Bundle

generateMap

  • Parameters

    Returns SourceMap

getIndentString

  • getIndentString(): string
  • Returns string

indent

  • indent(indentStr: string): Bundle
  • Parameters

    • indentStr: string

    Returns Bundle

prepend

  • prepend(content: string): Bundle
  • Parameters

    • content: string

    Returns Bundle

toString

  • toString(): string
  • Returns string

trim

  • trim(charType: string): Bundle
  • Parameters

    • charType: string

    Returns Bundle

trimEnd

  • trimEnd(charType: string): Bundle
  • Parameters

    • charType: string

    Returns Bundle

trimLines

  • Returns Bundle

trimStart

  • trimStart(charType: string): Bundle
  • Parameters

    • charType: string

    Returns Bundle

MagicString

MagicString:

constructor

Bundle

Bundle: any

addSourcemapLocation

  • addSourcemapLocation(char: number): void
  • Parameters

    • char: number

    Returns void

append

  • Parameters

    • content: string

    Returns MagicString

clone

  • Returns MagicString

generateMap

  • Parameters

    Returns SourceMap

getIndentString

  • getIndentString(): string
  • Returns string

indent

  • Parameters

    Returns MagicString

insert

  • Parameters

    • index: number
    • content: string

    Returns MagicString

locate

  • locate(index: number): number
  • Parameters

    • index: number

    Returns number

locateOrigin

  • locateOrigin(index: number): number
  • Parameters

    • index: number

    Returns number

overwrite

  • overwrite(start: number, end: number, content: string): MagicString
  • Parameters

    • start: number
    • end: number
    • content: string

    Returns MagicString

prepend

  • Parameters

    • content: string

    Returns MagicString

remove

  • Parameters

    • start: number
    • end: number

    Returns MagicString

slice

  • Parameters

    • start: number
    • end: number

    Returns MagicString

snip

  • Parameters

    • start: number
    • end: number

    Returns MagicString

toString

  • toString(): string
  • Returns string

trim

  • Parameters

    • Optional charType: string

    Returns MagicString

trimEnd

  • Parameters

    • Optional charType: string

    Returns MagicString

trimLines

  • Returns MagicString

trimStart

  • Parameters

    • Optional charType: string

    Returns MagicString

BundleOptions

BundleOptions:

intro

intro: string

outro

outro: string

separator

separator: string

BundleSource

BundleSource:

content

content: MagicString

filename

filename: string

separator

separator: string

Exclusion

Exclusion:

0

0: number

1

1: number

IndentOptions

IndentOptions:

exclude

exclude: Exclusion | Array<Exclusion>

indentStart

indentStart: boolean

MagicStringOptions

MagicStringOptions:

filename

filename: string

indentExclusionRanges

indentExclusionRanges: boolean

MapOptions

MapOptions:

file

file: string

hires

hires: boolean

includeContent

includeContent: boolean

source

source: string

SourceMap

SourceMap:

file

file: string

mappings

mappings: string

names

names: Array<string>

sourceRoot

sourceRoot: string

sources

sources: Array<string>

sourcesContent

sourcesContent: string[]

version

version: string

"typings/main/ambient/mocha/index.d"

"typings/main/ambient/mocha/index.d":

"mocha"

"mocha":

Mocha

Mocha:

reporters

reporters:

Base

Base:

constructor

  • Parameters

    Returns Base

stats

stats: object

Type declaration

  • failures: number
  • passes: number
  • pending: number
  • suites: number
  • tests: number

Doc

Doc:

constructor

  • Parameters

    Returns Doc

stats

stats: object

Type declaration

  • failures: number
  • passes: number
  • pending: number
  • suites: number
  • tests: number

Dot

Dot:

constructor

  • Parameters

    Returns Dot

stats

stats: object

Type declaration

  • failures: number
  • passes: number
  • pending: number
  • suites: number
  • tests: number

HTML

HTML:

constructor

stats

stats: object

Type declaration

  • failures: number
  • passes: number
  • pending: number
  • suites: number
  • tests: number

HTMLCov

HTMLCov:

constructor

stats

stats: object

Type declaration

  • failures: number
  • passes: number
  • pending: number
  • suites: number
  • tests: number

JSON

JSON:

constructor

stats

stats: object

Type declaration

  • failures: number
  • passes: number
  • pending: number
  • suites: number
  • tests: number

JSONCov

JSONCov:

constructor

stats

stats: object

Type declaration

  • failures: number
  • passes: number
  • pending: number
  • suites: number
  • tests: number

JSONStream

JSONStream:

constructor

stats

stats: object

Type declaration

  • failures: number
  • passes: number
  • pending: number
  • suites: number
  • tests: number

Landing

Landing:

constructor

stats

stats: object

Type declaration

  • failures: number
  • passes: number
  • pending: number
  • suites: number
  • tests: number

List

List:

constructor

stats

stats: object

Type declaration

  • failures: number
  • passes: number
  • pending: number
  • suites: number
  • tests: number

Markdown

Markdown:

constructor

stats

stats: object

Type declaration

  • failures: number
  • passes: number
  • pending: number
  • suites: number
  • tests: number

Min

Min:

constructor

  • Parameters

    Returns Min

stats

stats: object

Type declaration

  • failures: number
  • passes: number
  • pending: number
  • suites: number
  • tests: number

Nyan

Nyan:

constructor

stats

stats: object

Type declaration

  • failures: number
  • passes: number
  • pending: number
  • suites: number
  • tests: number

Progress

Progress:

constructor

  • Parameters

    • runner: IRunner
    • Optional options: object
      • Optional close?: string

        String used to indicate the end of the progress bar.

      • Optional complete?: string

        String used to indicate a complete test on the progress bar.

      • Optional incomplete?: string

        String used to indicate an incomplete test on the progress bar.

      • Optional open?: string

        String used to indicate the start of the progress bar.

    Returns Progress

stats

stats: object

Type declaration

  • failures: number
  • passes: number
  • pending: number
  • suites: number
  • tests: number

Spec

Spec:

constructor

stats

stats: object

Type declaration

  • failures: number
  • passes: number
  • pending: number
  • suites: number
  • tests: number

TAP

TAP:

constructor

  • Parameters

    Returns TAP

stats

stats: object

Type declaration

  • failures: number
  • passes: number
  • pending: number
  • suites: number
  • tests: number

XUnit

XUnit:

constructor

  • Parameters

    • runner: IRunner
    • Optional options: any

    Returns XUnit

stats

stats: object

Type declaration

  • failures: number
  • passes: number
  • pending: number
  • suites: number
  • tests: number

IContextDefinition

  • __call(description: string, spec: function): ISuite
  • Parameters

    • description: string
    • spec: function
        • (): void
        • Returns void

    Returns ISuite

only

  • only(description: string, spec: function): ISuite
  • Parameters

    • description: string
    • spec: function
        • (): void
        • Returns void

    Returns ISuite

skip

  • skip(description: string, spec: function): void
  • Parameters

    • description: string
    • spec: function
        • (): void
        • Returns void

    Returns void

timeout

  • timeout(ms: number): void
  • Parameters

    • ms: number

    Returns void

IRunnable

IRunnable:

Partial interface for Mocha's Runnable class.

async

async: boolean

fn

fn: Function

sync

sync: boolean

timedOut

timedOut: boolean

title

title: string

IRunner

IRunner:

Partial interface for Mocha's Runner class.

ISuite

ISuite:

Partial interface for Mocha's Suite class.

parent

parent: ISuite

title

title: string

fullTitle

  • fullTitle(): string
  • Returns string

ITest

ITest:

Partial interface for Mocha's Test class.

async

async: boolean

fn

fn: Function

parent

parent: ISuite

pending

pending: boolean

sync

sync: boolean

timedOut

timedOut: boolean

title

title: string

fullTitle

  • fullTitle(): string
  • Returns string

ITestDefinition

  • __call(expectation: string, assertion?: function): ITest
  • __call(expectation: string, assertion?: function): ITest
  • Parameters

    • expectation: string
    • Optional assertion: function
        • (): void
        • Returns void

    Returns ITest

  • Parameters

    • expectation: string
    • Optional assertion: function

    Returns ITest

only

  • only(expectation: string, assertion?: function): ITest
  • only(expectation: string, assertion?: function): ITest
  • Parameters

    • expectation: string
    • Optional assertion: function
        • (): void
        • Returns void

    Returns ITest

  • Parameters

    • expectation: string
    • Optional assertion: function

    Returns ITest

skip

  • skip(expectation: string, assertion?: function): void
  • skip(expectation: string, assertion?: function): void
  • Parameters

    • expectation: string
    • Optional assertion: function
        • (): void
        • Returns void

    Returns void

  • Parameters

    • expectation: string
    • Optional assertion: function

    Returns void

timeout

  • timeout(ms: number): void
  • Parameters

    • ms: number

    Returns void

constructor

  • new Mocha(options?: object): Mocha
  • Parameters

    • Optional options: object
      • Optional bail?: boolean
      • Optional grep?: RegExp
      • Optional reporter?: string
      • Optional timeout?: number
      • Optional ui?: string

    Returns Mocha

addFile

  • addFile(file: string): Mocha
  • Parameters

    • file: string

    Returns Mocha

asyncOnly

  • asyncOnly(value: boolean): Mocha
  • Parameters

    • value: boolean

    Returns Mocha

bail

  • bail(value?: boolean): Mocha
  • Parameters

    • Optional value: boolean

    Returns Mocha

checkLeaks

  • Returns Mocha

enableTimeouts

  • enableTimeouts(value: boolean): Mocha
  • Parameters

    • value: boolean

    Returns Mocha

globals

  • globals(value: string): Mocha
  • globals(values: string[]): Mocha
  • Parameters

    • value: string

    Returns Mocha

  • Parameters

    • values: string[]

    Returns Mocha

grep

  • grep(value: string): Mocha
  • grep(value: RegExp): Mocha
  • Parameters

    • value: string

    Returns Mocha

  • Parameters

    • value: RegExp

    Returns Mocha

growl

  • Enables growl support.

    Returns Mocha

ignoreLeaks

  • ignoreLeaks(value: boolean): Mocha
  • Parameters

    • value: boolean

    Returns Mocha

invert

  • Returns Mocha

noHighlighting

  • noHighlighting(value: boolean): Mocha
  • Parameters

    • value: boolean

    Returns Mocha

reporter

  • reporter(name: string): Mocha
  • reporter(reporter: function): Mocha
  • Sets reporter by name, defaults to "spec".

    Parameters

    • name: string

    Returns Mocha

  • Sets reporter constructor, defaults to mocha.reporters.Spec.

    Parameters

    • reporter: function
        • (runner: IRunner, options: any): any
        • Parameters

          Returns any

    Returns Mocha

run

  • run(onComplete?: function): IRunner
  • Runs tests and invokes onComplete() when finished.

    Parameters

    • Optional onComplete: function
        • (failures: number): void
        • Parameters

          • failures: number

          Returns void

    Returns IRunner

setup

  • Setup mocha with the given options.

    Parameters

    Returns Mocha

slow

  • slow(value: number): Mocha
  • Parameters

    • value: number

    Returns Mocha

timeout

  • timeout(value: number): Mocha
  • Parameters

    • value: number

    Returns Mocha

ui

  • ui(value: string): Mocha
  • Parameters

    • value: string

    Returns Mocha

useColors

  • useColors(value: boolean): Mocha
  • Parameters

    • value: boolean

    Returns Mocha

useInlineDiffs

  • useInlineDiffs(value: boolean): Mocha
  • Parameters

    • value: boolean

    Returns Mocha

MochaDone

  • __call(error?: Error): void
  • Parameters

    • Optional error: Error

    Returns void

MochaSetupOptions

MochaSetupOptions:

bail

bail: boolean

globals

globals: any[]

grep

grep: any

ignoreLeaks

ignoreLeaks: boolean

reporter

reporter: any

slow

slow: number

timeout

timeout: number

ui

ui: string

context

describe

it

mocha

mocha: Mocha

suite

test

xdescribe

xit

after

  • after(action: function): void
  • after(action: function): void
  • Parameters

    • action: function
        • (): void
        • Returns void

    Returns void

  • Parameters

    Returns void

afterEach

  • afterEach(action: function): void
  • afterEach(action: function): void
  • Parameters

    • action: function
        • (): void
        • Returns void

    Returns void

  • Parameters

    Returns void

before

  • before(action: function): void
  • before(action: function): void
  • Parameters

    • action: function
        • (): void
        • Returns void

    Returns void

  • Parameters

    Returns void

beforeEach

  • beforeEach(action: function): void
  • beforeEach(action: function): void
  • Parameters

    • action: function
        • (): void
        • Returns void

    Returns void

  • Parameters

    Returns void

setup

  • setup(action: function): void
  • setup(action: function): void
  • Parameters

    • action: function
        • (): void
        • Returns void

    Returns void

  • Parameters

    Returns void

suiteSetup

  • suiteSetup(action: function): void
  • suiteSetup(action: function): void
  • Parameters

    • action: function
        • (): void
        • Returns void

    Returns void

  • Parameters

    Returns void

suiteTeardown

  • suiteTeardown(action: function): void
  • suiteTeardown(action: function): void
  • Parameters

    • action: function
        • (): void
        • Returns void

    Returns void

  • Parameters

    Returns void

teardown

  • teardown(action: function): void
  • teardown(action: function): void
  • Parameters

    • action: function
        • (): void
        • Returns void

    Returns void

  • Parameters

    Returns void

"typings/main/ambient/node/index.d"

"typings/main/ambient/node/index.d":

"assert"

"assert":

internal

  • internal(value: any, message?: string): void
  • Parameters

    • value: any
    • Optional message: string

    Returns void

AssertionError

AssertionError:

constructor

  • Parameters

    • Optional options: object
      • Optional actual?: any
      • Optional expected?: any
      • Optional message?: string
      • Optional operator?: string
      • Optional stackStartFunction?: Function

    Returns AssertionError

actual

actual: any

expected

expected: any

generatedMessage

generatedMessage: boolean

message

message: string

name

name: string

operator

operator: string

doesNotThrow

doesNotThrow: function

Type declaration

    • (block: Function, message?: string): void
    • (block: Function, error: Function, message?: string): void
    • (block: Function, error: RegExp, message?: string): void
    • (block: Function, error: function, message?: string): void
    • Parameters

      • block: Function
      • Optional message: string

      Returns void

    • Parameters

      • block: Function
      • error: Function
      • Optional message: string

      Returns void

    • Parameters

      • block: Function
      • error: RegExp
      • Optional message: string

      Returns void

    • Parameters

      • block: Function
      • error: function
          • (err: any): boolean
          • Parameters

            • err: any

            Returns boolean

      • Optional message: string

      Returns void

throws

throws: function

Type declaration

    • (block: Function, message?: string): void
    • (block: Function, error: Function, message?: string): void
    • (block: Function, error: RegExp, message?: string): void
    • (block: Function, error: function, message?: string): void
    • Parameters

      • block: Function
      • Optional message: string

      Returns void

    • Parameters

      • block: Function
      • error: Function
      • Optional message: string

      Returns void

    • Parameters

      • block: Function
      • error: RegExp
      • Optional message: string

      Returns void

    • Parameters

      • block: Function
      • error: function
          • (err: any): boolean
          • Parameters

            • err: any

            Returns boolean

      • Optional message: string

      Returns void

deepEqual

  • deepEqual(actual: any, expected: any, message?: string): void
  • Parameters

    • actual: any
    • expected: any
    • Optional message: string

    Returns void

equal

  • equal(actual: any, expected: any, message?: string): void
  • Parameters

    • actual: any
    • expected: any
    • Optional message: string

    Returns void

fail

  • fail(actual?: any, expected?: any, message?: string, operator?: string): void
  • Parameters

    • Optional actual: any
    • Optional expected: any
    • Optional message: string
    • Optional operator: string

    Returns void

ifError

  • ifError(value: any): void
  • Parameters

    • value: any

    Returns void

notDeepEqual

  • notDeepEqual(acutal: any, expected: any, message?: string): void
  • Parameters

    • acutal: any
    • expected: any
    • Optional message: string

    Returns void

notEqual

  • notEqual(actual: any, expected: any, message?: string): void
  • Parameters

    • actual: any
    • expected: any
    • Optional message: string

    Returns void

notStrictEqual

  • notStrictEqual(actual: any, expected: any, message?: string): void
  • Parameters

    • actual: any
    • expected: any
    • Optional message: string

    Returns void

ok

  • ok(value: any, message?: string): void
  • Parameters

    • value: any
    • Optional message: string

    Returns void

strictEqual

  • strictEqual(actual: any, expected: any, message?: string): void
  • Parameters

    • actual: any
    • expected: any
    • Optional message: string

    Returns void

"buffer"

"buffer":
                                          *
              MODULES                     *
                                          *

INSPECT_MAX_BYTES

INSPECT_MAX_BYTES: number

"child_process"

"child_process":

ChildProcess

ChildProcess:

pid

pid: number

stderr

stderr: Readable

stdin

stdin: Writable

stdout

stdout: Readable

addListener

  • addListener(event: string, listener: Function): EventEmitter

disconnect

  • disconnect(): void
  • Returns void

emit

  • emit(event: string, ...args: any[]): boolean
  • Parameters

    • event: string
    • Rest ...args: any[]

    Returns boolean

kill

  • kill(signal?: string): void
  • Parameters

    • Optional signal: string

    Returns void

listeners

  • listeners(event: string): Function[]
  • Parameters

    • event: string

    Returns Function[]

on

  • Parameters

    • event: string
    • listener: Function

    Returns EventEmitter

once

  • Parameters

    • event: string
    • listener: Function

    Returns EventEmitter

removeAllListeners

removeListener

  • removeListener(event: string, listener: Function): EventEmitter

send

  • send(message: any, sendHandle?: any): void
  • Parameters

    • message: any
    • Optional sendHandle: any

    Returns void

setMaxListeners

  • setMaxListeners(n: number): void

unref

  • unref(): void
  • Returns void

listenerCount

  • listenerCount(emitter: EventEmitter, event: string): number

exec

  • exec(command: string, options: object, callback?: function): ChildProcess
  • exec(command: string, callback?: function): ChildProcess
  • Parameters

    • command: string
    • options: object
      • Optional customFds?: any
      • Optional cwd?: string
      • Optional encoding?: string
      • Optional env?: any
      • Optional killSignal?: string
      • Optional maxBuffer?: number
      • Optional stdio?: any
      • Optional timeout?: number
    • Optional callback: function
        • Parameters

          Returns void

    Returns ChildProcess

  • Parameters

    • command: string
    • Optional callback: function
        • Parameters

          Returns void

    Returns ChildProcess

execFile

  • execFile(file: string, callback?: function): ChildProcess
  • execFile(file: string, args?: string[], callback?: function): ChildProcess
  • execFile(file: string, args?: string[], options?: object, callback?: function): ChildProcess
  • Parameters

    • file: string
    • Optional callback: function
        • Parameters

          Returns void

    Returns ChildProcess

  • Parameters

    • file: string
    • Optional args: string[]
    • Optional callback: function
        • Parameters

          Returns void

    Returns ChildProcess

  • Parameters

    • file: string
    • Optional args: string[]
    • Optional options: object
      • Optional customFds?: any
      • Optional cwd?: string
      • Optional encoding?: string
      • Optional env?: any
      • Optional killSignal?: string
      • Optional maxBuffer?: string
      • Optional stdio?: any
      • Optional timeout?: number
    • Optional callback: function
        • Parameters

          Returns void

    Returns ChildProcess

execFileSync

  • execFileSync(command: string, args?: string[], options?: object): ChildProcess
  • Parameters

    • command: string
    • Optional args: string[]
    • Optional options: object
      • Optional cwd?: string
      • Optional encoding?: string
      • Optional env?: any
      • Optional gid?: number
      • Optional input?: string | Buffer
      • Optional killSignal?: string
      • Optional maxBuffer?: number
      • Optional stdio?: any
      • Optional timeout?: number
      • Optional uid?: number

    Returns ChildProcess

execSync

  • Parameters

    • command: string
    • Optional options: object
      • Optional cwd?: string
      • Optional encoding?: string
      • Optional env?: any
      • Optional gid?: number
      • Optional input?: string | Buffer
      • Optional killSignal?: string
      • Optional maxBuffer?: number
      • Optional stdio?: any
      • Optional timeout?: number
      • Optional uid?: number

    Returns ChildProcess

fork

  • fork(modulePath: string, args?: string[], options?: object): ChildProcess
  • Parameters

    • modulePath: string
    • Optional args: string[]
    • Optional options: object
      • Optional cwd?: string
      • Optional encoding?: string
      • Optional env?: any

    Returns ChildProcess

spawn

  • spawn(command: string, args?: string[], options?: object): ChildProcess
  • Parameters

    • command: string
    • Optional args: string[]
    • Optional options: object
      • Optional custom?: any
      • Optional cwd?: string
      • Optional detached?: boolean
      • Optional env?: any
      • Optional stdio?: any

    Returns ChildProcess

"cluster"

"cluster":

Worker

Worker:

id

id: string

process

process: ChildProcess

suicide

suicide: boolean

addListener

  • addListener(event: string, listener: Function): EventEmitter

destroy

  • destroy(signal?: string): void
  • Parameters

    • Optional signal: string

    Returns void

disconnect

  • disconnect(): void
  • Returns void

emit

  • emit(event: string, ...args: any[]): boolean
  • Parameters

    • event: string
    • Rest ...args: any[]

    Returns boolean

kill

  • kill(signal?: string): void
  • Parameters

    • Optional signal: string

    Returns void

listeners

  • listeners(event: string): Function[]

on

once

removeAllListeners

removeListener

  • removeListener(event: string, listener: Function): EventEmitter

send

  • send(message: any, sendHandle?: any): void
  • Parameters

    • message: any
    • Optional sendHandle: any

    Returns void

setMaxListeners

  • setMaxListeners(n: number): void

listenerCount

  • listenerCount(emitter: EventEmitter, event: string): number

ClusterSettings

ClusterSettings:

args

args: string[]

exec

exec: string

silent

silent: boolean

isMaster

isMaster: boolean

isWorker

isWorker: boolean

settings

settings: ClusterSettings

worker

worker: Worker

workers

workers: Worker[]

addListener

  • addListener(event: string, listener: Function): void
  • Parameters

    • event: string
    • listener: Function

    Returns void

disconnect

  • disconnect(callback?: Function): void
  • Parameters

    • Optional callback: Function

    Returns void

emit

  • emit(event: string, ...args: any[]): boolean
  • Parameters

    • event: string
    • Rest ...args: any[]

    Returns boolean

fork

  • Parameters

    • Optional env: any

    Returns Worker

listeners

  • listeners(event: string): Function[]
  • Parameters

    • event: string

    Returns Function[]

on

  • on(event: string, listener: Function): any
  • Parameters

    • event: string
    • listener: Function

    Returns any

once

  • once(event: string, listener: Function): void
  • Parameters

    • event: string
    • listener: Function

    Returns void

removeAllListeners

  • removeAllListeners(event?: string): void
  • Parameters

    • Optional event: string

    Returns void

removeListener

  • removeListener(event: string, listener: Function): void
  • Parameters

    • event: string
    • listener: Function

    Returns void

setMaxListeners

  • setMaxListeners(n: number): void
  • Parameters

    • n: number

    Returns void

setupMaster

  • Parameters

    Returns void

"constants"

"constants":

DH_CHECK_P_NOT_PRIME

DH_CHECK_P_NOT_PRIME: number

DH_CHECK_P_NOT_SAFE_PRIME

DH_CHECK_P_NOT_SAFE_PRIME: number

DH_NOT_SUITABLE_GENERATOR

DH_NOT_SUITABLE_GENERATOR: number

DH_UNABLE_TO_CHECK_GENERATOR

DH_UNABLE_TO_CHECK_GENERATOR: number

E2BIG

E2BIG: number

EACCES

EACCES: number

EADDRINUSE

EADDRINUSE: number

EADDRNOTAVAIL

EADDRNOTAVAIL: number

EAFNOSUPPORT

EAFNOSUPPORT: number

EAGAIN

EAGAIN: number

EALREADY

EALREADY: number

EBADF

EBADF: number

EBADMSG

EBADMSG: number

EBUSY

EBUSY: number

ECANCELED

ECANCELED: number

ECHILD

ECHILD: number

ECONNABORTED

ECONNABORTED: number

ECONNREFUSED

ECONNREFUSED: number

ECONNRESET

ECONNRESET: number

EDEADLK

EDEADLK: number

EDESTADDRREQ

EDESTADDRREQ: number

EDOM

EDOM: number

EEXIST

EEXIST: number

EFAULT

EFAULT: number

EFBIG

EFBIG: number

EHOSTUNREACH

EHOSTUNREACH: number

EIDRM

EIDRM: number

EILSEQ

EILSEQ: number

EINPROGRESS

EINPROGRESS: number

EINTR

EINTR: number

EINVAL

EINVAL: number

EIO

EIO: number

EISCONN

EISCONN: number

EISDIR

EISDIR: number

ELOOP

ELOOP: number

EMFILE

EMFILE: number

EMLINK

EMLINK: number

EMSGSIZE

EMSGSIZE: number

ENAMETOOLONG

ENAMETOOLONG: number

ENETDOWN

ENETDOWN: number

ENETRESET

ENETRESET: number

ENETUNREACH

ENETUNREACH: number

ENFILE

ENFILE: number

ENGINE_METHOD_ALL

ENGINE_METHOD_ALL: number

ENGINE_METHOD_CIPHERS

ENGINE_METHOD_CIPHERS: number

ENGINE_METHOD_DH

ENGINE_METHOD_DH: number

ENGINE_METHOD_DIGESTS

ENGINE_METHOD_DIGESTS: number

ENGINE_METHOD_DSA

ENGINE_METHOD_DSA: number

ENGINE_METHOD_ECDH

ENGINE_METHOD_ECDH: number

ENGINE_METHOD_ECDSA

ENGINE_METHOD_ECDSA: number

ENGINE_METHOD_NONE

ENGINE_METHOD_NONE: number

ENGINE_METHOD_PKEY_ASN1_METHS

ENGINE_METHOD_PKEY_ASN1_METHS: number

ENGINE_METHOD_PKEY_METHS

ENGINE_METHOD_PKEY_METHS: number

ENGINE_METHOD_RAND

ENGINE_METHOD_RAND: number

ENGINE_METHOD_STORE

ENGINE_METHOD_STORE: number

ENOBUFS

ENOBUFS: number

ENODATA

ENODATA: number

ENODEV

ENODEV: number

ENOENT

ENOENT: number

ENOEXEC

ENOEXEC: number

ENOLCK

ENOLCK: number

ENOLINK

ENOLINK: number

ENOMEM

ENOMEM: number

ENOMSG

ENOMSG: number

ENOPROTOOPT

ENOPROTOOPT: number

ENOSPC

ENOSPC: number

ENOSR

ENOSR: number

ENOSTR

ENOSTR: number

ENOSYS

ENOSYS: number

ENOTCONN

ENOTCONN: number

ENOTDIR

ENOTDIR: number

ENOTEMPTY

ENOTEMPTY: number

ENOTSOCK

ENOTSOCK: number

ENOTSUP

ENOTSUP: number

ENOTTY

ENOTTY: number

ENXIO

ENXIO: number

EOPNOTSUPP

EOPNOTSUPP: number

EOVERFLOW

EOVERFLOW: number

EPERM

EPERM: number

EPIPE

EPIPE: number

EPROTO

EPROTO: number

EPROTONOSUPPORT

EPROTONOSUPPORT: number

EPROTOTYPE

EPROTOTYPE: number

ERANGE

ERANGE: number

EROFS

EROFS: number

ESPIPE

ESPIPE: number

ESRCH

ESRCH: number

ETIME

ETIME: number

ETIMEDOUT

ETIMEDOUT: number

ETXTBSY

ETXTBSY: number

EWOULDBLOCK

EWOULDBLOCK: number

EXDEV

EXDEV: number

F_OK

F_OK: number

NPN_ENABLED

NPN_ENABLED: number

O_APPEND

O_APPEND: number

O_CREAT

O_CREAT: number

O_EXCL

O_EXCL: number

O_RDONLY

O_RDONLY: number

O_RDWR

O_RDWR: number

O_TRUNC

O_TRUNC: number

O_WRONLY

O_WRONLY: number

POINT_CONVERSION_COMPRESSED

POINT_CONVERSION_COMPRESSED: number

POINT_CONVERSION_HYBRID

POINT_CONVERSION_HYBRID: number

POINT_CONVERSION_UNCOMPRESSED

POINT_CONVERSION_UNCOMPRESSED: number

RSA_NO_PADDING

RSA_NO_PADDING: number

RSA_PKCS1_OAEP_PADDING

RSA_PKCS1_OAEP_PADDING: number

RSA_PKCS1_PADDING

RSA_PKCS1_PADDING: number

RSA_PKCS1_PSS_PADDING

RSA_PKCS1_PSS_PADDING: number

RSA_SSLV23_PADDING

RSA_SSLV23_PADDING: number

RSA_X931_PADDING

RSA_X931_PADDING: number

R_OK

R_OK: number

SIGABRT

SIGABRT: number

SIGBREAK

SIGBREAK: number

SIGFPE

SIGFPE: number

SIGHUP

SIGHUP: number

SIGILL

SIGILL: number

SIGINT

SIGINT: number

SIGKILL

SIGKILL: number

SIGSEGV

SIGSEGV: number

SIGTERM

SIGTERM: number

SIGWINCH

SIGWINCH: number

SSL_OP_ALL

SSL_OP_ALL: number

SSL_OP_ALLOW_UNSAFE_LEGACY_RENEGOTIATION

SSL_OP_ALLOW_UNSAFE_LEGACY_RENEGOTIATION: number

SSL_OP_CIPHER_SERVER_PREFERENCE

SSL_OP_CIPHER_SERVER_PREFERENCE: number

SSL_OP_CISCO_ANYCONNECT

SSL_OP_CISCO_ANYCONNECT: number

SSL_OP_COOKIE_EXCHANGE

SSL_OP_COOKIE_EXCHANGE: number

SSL_OP_CRYPTOPRO_TLSEXT_BUG

SSL_OP_CRYPTOPRO_TLSEXT_BUG: number

SSL_OP_DONT_INSERT_EMPTY_FRAGMENTS

SSL_OP_DONT_INSERT_EMPTY_FRAGMENTS: number

SSL_OP_EPHEMERAL_RSA

SSL_OP_EPHEMERAL_RSA: number

SSL_OP_LEGACY_SERVER_CONNECT

SSL_OP_LEGACY_SERVER_CONNECT: number

SSL_OP_MICROSOFT_BIG_SSLV3_BUFFER

SSL_OP_MICROSOFT_BIG_SSLV3_BUFFER: number

SSL_OP_MICROSOFT_SESS_ID_BUG

SSL_OP_MICROSOFT_SESS_ID_BUG: number

SSL_OP_MSIE_SSLV2_RSA_PADDING

SSL_OP_MSIE_SSLV2_RSA_PADDING: number

SSL_OP_NETSCAPE_CA_DN_BUG

SSL_OP_NETSCAPE_CA_DN_BUG: number

SSL_OP_NETSCAPE_CHALLENGE_BUG

SSL_OP_NETSCAPE_CHALLENGE_BUG: number

SSL_OP_NETSCAPE_DEMO_CIPHER_CHANGE_BUG

SSL_OP_NETSCAPE_DEMO_CIPHER_CHANGE_BUG: number

SSL_OP_NETSCAPE_REUSE_CIPHER_CHANGE_BUG

SSL_OP_NETSCAPE_REUSE_CIPHER_CHANGE_BUG: number

SSL_OP_NO_COMPRESSION

SSL_OP_NO_COMPRESSION: number

SSL_OP_NO_QUERY_MTU

SSL_OP_NO_QUERY_MTU: number

SSL_OP_NO_SESSION_RESUMPTION_ON_RENEGOTIATION

SSL_OP_NO_SESSION_RESUMPTION_ON_RENEGOTIATION: number

SSL_OP_NO_SSLv2

SSL_OP_NO_SSLv2: number

SSL_OP_NO_SSLv3

SSL_OP_NO_SSLv3: number

SSL_OP_NO_TICKET

SSL_OP_NO_TICKET: number

SSL_OP_NO_TLSv1

SSL_OP_NO_TLSv1: number

SSL_OP_NO_TLSv1_1

SSL_OP_NO_TLSv1_1: number

SSL_OP_NO_TLSv1_2

SSL_OP_NO_TLSv1_2: number

SSL_OP_PKCS1_CHECK_1

SSL_OP_PKCS1_CHECK_1: number

SSL_OP_PKCS1_CHECK_2

SSL_OP_PKCS1_CHECK_2: number

SSL_OP_SINGLE_DH_USE

SSL_OP_SINGLE_DH_USE: number

SSL_OP_SINGLE_ECDH_USE

SSL_OP_SINGLE_ECDH_USE: number

SSL_OP_SSLEAY_080_CLIENT_DH_BUG

SSL_OP_SSLEAY_080_CLIENT_DH_BUG: number

SSL_OP_SSLREF2_REUSE_CERT_TYPE_BUG

SSL_OP_SSLREF2_REUSE_CERT_TYPE_BUG: number

SSL_OP_TLS_BLOCK_PADDING_BUG

SSL_OP_TLS_BLOCK_PADDING_BUG: number

SSL_OP_TLS_D5_BUG

SSL_OP_TLS_D5_BUG: number

SSL_OP_TLS_ROLLBACK_BUG

SSL_OP_TLS_ROLLBACK_BUG: number

S_IFCHR

S_IFCHR: number

S_IFDIR

S_IFDIR: number

S_IFLNK

S_IFLNK: number

S_IFMT

S_IFMT: number

S_IFREG

S_IFREG: number

UV_UDP_REUSEADDR

UV_UDP_REUSEADDR: number

WSAEACCES

WSAEACCES: number

WSAEADDRINUSE

WSAEADDRINUSE: number

WSAEADDRNOTAVAIL

WSAEADDRNOTAVAIL: number

WSAEAFNOSUPPORT

WSAEAFNOSUPPORT: number

WSAEALREADY

WSAEALREADY: number

WSAEBADF

WSAEBADF: number

WSAECANCELLED

WSAECANCELLED: number

WSAECONNABORTED

WSAECONNABORTED: number

WSAECONNREFUSED

WSAECONNREFUSED: number

WSAECONNRESET

WSAECONNRESET: number

WSAEDESTADDRREQ

WSAEDESTADDRREQ: number

WSAEDISCON

WSAEDISCON: number

WSAEDQUOT

WSAEDQUOT: number

WSAEFAULT

WSAEFAULT: number

WSAEHOSTDOWN

WSAEHOSTDOWN: number

WSAEHOSTUNREACH

WSAEHOSTUNREACH: number

WSAEINPROGRESS

WSAEINPROGRESS: number

WSAEINTR

WSAEINTR: number

WSAEINVAL

WSAEINVAL: number

WSAEINVALIDPROCTABLE

WSAEINVALIDPROCTABLE: number

WSAEINVALIDPROVIDER

WSAEINVALIDPROVIDER: number

WSAEISCONN

WSAEISCONN: number

WSAELOOP

WSAELOOP: number

WSAEMFILE

WSAEMFILE: number

WSAEMSGSIZE

WSAEMSGSIZE: number

WSAENAMETOOLONG

WSAENAMETOOLONG: number

WSAENETDOWN

WSAENETDOWN: number

WSAENETRESET

WSAENETRESET: number

WSAENETUNREACH

WSAENETUNREACH: number

WSAENOBUFS

WSAENOBUFS: number

WSAENOMORE

WSAENOMORE: number

WSAENOPROTOOPT

WSAENOPROTOOPT: number

WSAENOTCONN

WSAENOTCONN: number

WSAENOTEMPTY

WSAENOTEMPTY: number

WSAENOTSOCK

WSAENOTSOCK: number

WSAEOPNOTSUPP

WSAEOPNOTSUPP: number

WSAEPFNOSUPPORT

WSAEPFNOSUPPORT: number

WSAEPROCLIM

WSAEPROCLIM: number

WSAEPROTONOSUPPORT

WSAEPROTONOSUPPORT: number

WSAEPROTOTYPE

WSAEPROTOTYPE: number

WSAEPROVIDERFAILEDINIT

WSAEPROVIDERFAILEDINIT: number

WSAEREFUSED

WSAEREFUSED: number

WSAEREMOTE

WSAEREMOTE: number

WSAESHUTDOWN

WSAESHUTDOWN: number

WSAESOCKTNOSUPPORT

WSAESOCKTNOSUPPORT: number

WSAESTALE

WSAESTALE: number

WSAETIMEDOUT

WSAETIMEDOUT: number

WSAETOOMANYREFS

WSAETOOMANYREFS: number

WSAEUSERS

WSAEUSERS: number

WSAEWOULDBLOCK

WSAEWOULDBLOCK: number

WSANOTINITIALISED

WSANOTINITIALISED: number

WSASERVICE_NOT_FOUND

WSASERVICE_NOT_FOUND: number

WSASYSCALLFAILURE

WSASYSCALLFAILURE: number

WSASYSNOTREADY

WSASYSNOTREADY: number

WSATYPE_NOT_FOUND

WSATYPE_NOT_FOUND: number

WSAVERNOTSUPPORTED

WSAVERNOTSUPPORTED: number

WSA_E_CANCELLED

WSA_E_CANCELLED: number

WSA_E_NO_MORE

WSA_E_NO_MORE: number

W_OK

W_OK: number

X_OK

X_OK: number

"crypto"

"crypto":

Cipher

Cipher:

final

  • final(): Buffer
  • final(output_encoding: string): string
  • Returns Buffer

  • Parameters

    • output_encoding: string

    Returns string

setAutoPadding

  • setAutoPadding(auto_padding: boolean): void
  • Parameters

    • auto_padding: boolean

    Returns void

update

  • update(data: Buffer): Buffer
  • update(data: string, input_encoding?: string, output_encoding?: string): string
  • Parameters

    Returns Buffer

  • Parameters

    • data: string
    • Optional input_encoding: string
    • Optional output_encoding: string

    Returns string

CredentialDetails

CredentialDetails:

ca

ca: any

cert

cert: string

ciphers

ciphers: string

crl

crl: any

key

key: string

passphrase

passphrase: string

pfx

pfx: string

Credentials

Credentials:

context

context: any

Decipher

Decipher:

final

  • final(): Buffer
  • final(output_encoding: string): string
  • Returns Buffer

  • Parameters

    • output_encoding: string

    Returns string

setAutoPadding

  • setAutoPadding(auto_padding: boolean): void
  • Parameters

    • auto_padding: boolean

    Returns void

update

  • update(data: Buffer): Buffer
  • update(data: string, input_encoding?: string, output_encoding?: string): string
  • Parameters

    Returns Buffer

  • Parameters

    • data: string
    • Optional input_encoding: string
    • Optional output_encoding: string

    Returns string

DiffieHellman

DiffieHellman:

computeSecret

  • computeSecret(other_public_key: string, input_encoding?: string, output_encoding?: string): string
  • Parameters

    • other_public_key: string
    • Optional input_encoding: string
    • Optional output_encoding: string

    Returns string

generateKeys

  • generateKeys(encoding?: string): string
  • Parameters

    • Optional encoding: string

    Returns string

getGenerator

  • getGenerator(encoding: string): string
  • Parameters

    • encoding: string

    Returns string

getPrime

  • getPrime(encoding?: string): string
  • Parameters

    • Optional encoding: string

    Returns string

getPrivateKey

  • getPrivateKey(encoding?: string): string
  • Parameters

    • Optional encoding: string

    Returns string

getPublicKey

  • getPublicKey(encoding?: string): string
  • Parameters

    • Optional encoding: string

    Returns string

setPrivateKey

  • setPrivateKey(public_key: string, encoding?: string): void
  • Parameters

    • public_key: string
    • Optional encoding: string

    Returns void

setPublicKey

  • setPublicKey(public_key: string, encoding?: string): void
  • Parameters

    • public_key: string
    • Optional encoding: string

    Returns void

Hash

Hash:

digest

  • digest(encoding: "buffer"): Buffer
  • digest(encoding: string): any
  • digest(): Buffer
  • Parameters

    • encoding: "buffer"

    Returns Buffer

  • Parameters

    • encoding: string

    Returns any

  • Returns Buffer

update

  • update(data: any, input_encoding?: string): Hash
  • Parameters

    • data: any
    • Optional input_encoding: string

    Returns Hash

Hmac

Hmac:

digest

  • digest(encoding: "buffer"): Buffer
  • digest(encoding: string): any
  • digest(): Buffer
  • Parameters

    • encoding: "buffer"

    Returns Buffer

  • Parameters

    • encoding: string

    Returns any

  • Returns Buffer

update

  • update(data: any, input_encoding?: string): Hmac
  • Parameters

    • data: any
    • Optional input_encoding: string

    Returns Hmac

Signer

Signer:

writable

writable: boolean

addListener

  • addListener(event: string, listener: Function): EventEmitter

emit

  • emit(event: string, ...args: any[]): boolean
  • Parameters

    • event: string
    • Rest ...args: any[]

    Returns boolean

end

  • end(): void
  • end(buffer: Buffer, cb?: Function): void
  • end(str: string, cb?: Function): void
  • end(str: string, encoding?: string, cb?: Function): void
  • Returns void

  • Parameters

    • buffer: Buffer
    • Optional cb: Function

    Returns void

  • Parameters

    • str: string
    • Optional cb: Function

    Returns void

  • Parameters

    • str: string
    • Optional encoding: string
    • Optional cb: Function

    Returns void

listeners

  • listeners(event: string): Function[]
  • Parameters

    • event: string

    Returns Function[]

on

  • Parameters

    • event: string
    • listener: Function

    Returns EventEmitter

once

  • Parameters

    • event: string
    • listener: Function

    Returns EventEmitter

removeAllListeners

removeListener

  • removeListener(event: string, listener: Function): EventEmitter

setMaxListeners

  • setMaxListeners(n: number): void

sign

  • sign(private_key: string, output_format: string): string
  • Parameters

    • private_key: string
    • output_format: string

    Returns string

update

  • update(data: any): void
  • Parameters

    • data: any

    Returns void

write

  • write(buffer: Buffer, cb?: Function): boolean
  • write(str: string, cb?: Function): boolean
  • write(str: string, encoding?: string, cb?: Function): boolean
  • Parameters

    • buffer: Buffer
    • Optional cb: Function

    Returns boolean

  • Parameters

    • str: string
    • Optional cb: Function

    Returns boolean

  • Parameters

    • str: string
    • Optional encoding: string
    • Optional cb: Function

    Returns boolean

Verify

Verify:

writable

writable: boolean

addListener

  • addListener(event: string, listener: Function): EventEmitter

emit

  • emit(event: string, ...args: any[]): boolean
  • Parameters

    • event: string
    • Rest ...args: any[]

    Returns boolean

end

  • end(): void
  • end(buffer: Buffer, cb?: Function): void
  • end(str: string, cb?: Function): void
  • end(str: string, encoding?: string, cb?: Function): void
  • Returns void

  • Parameters

    • buffer: Buffer
    • Optional cb: Function

    Returns void

  • Parameters

    • str: string
    • Optional cb: Function

    Returns void

  • Parameters

    • str: string
    • Optional encoding: string
    • Optional cb: Function

    Returns void

listeners

  • listeners(event: string): Function[]
  • Parameters

    • event: string

    Returns Function[]

on

  • Parameters

    • event: string
    • listener: Function

    Returns EventEmitter

once

  • Parameters

    • event: string
    • listener: Function

    Returns EventEmitter

removeAllListeners

removeListener

  • removeListener(event: string, listener: Function): EventEmitter

setMaxListeners

  • setMaxListeners(n: number): void

update

  • update(data: any): void
  • Parameters

    • data: any

    Returns void

verify

  • verify(object: string, signature: string, signature_format?: string): boolean
  • Parameters

    • object: string
    • signature: string
    • Optional signature_format: string

    Returns boolean

write

  • write(buffer: Buffer, cb?: Function): boolean
  • write(str: string, cb?: Function): boolean
  • write(str: string, encoding?: string, cb?: Function): boolean
  • Parameters

    • buffer: Buffer
    • Optional cb: Function

    Returns boolean

  • Parameters

    • str: string
    • Optional cb: Function

    Returns boolean

  • Parameters

    • str: string
    • Optional encoding: string
    • Optional cb: Function

    Returns boolean

createCipher

  • createCipher(algorithm: string, password: any): Cipher
  • Parameters

    • algorithm: string
    • password: any

    Returns Cipher

createCipheriv

  • createCipheriv(algorithm: string, key: any, iv: any): Cipher
  • Parameters

    • algorithm: string
    • key: any
    • iv: any

    Returns Cipher

createCredentials

createDecipher

  • createDecipher(algorithm: string, password: any): Decipher
  • Parameters

    • algorithm: string
    • password: any

    Returns Decipher

createDecipheriv

  • createDecipheriv(algorithm: string, key: any, iv: any): Decipher
  • Parameters

    • algorithm: string
    • key: any
    • iv: any

    Returns Decipher

createDiffieHellman

  • Parameters

    • prime_length: number

    Returns DiffieHellman

  • Parameters

    • prime: number
    • Optional encoding: string

    Returns DiffieHellman

createHash

  • createHash(algorithm: string): Hash
  • Parameters

    • algorithm: string

    Returns Hash

createHmac

  • createHmac(algorithm: string, key: string): Hmac
  • createHmac(algorithm: string, key: Buffer): Hmac
  • Parameters

    • algorithm: string
    • key: string

    Returns Hmac

  • Parameters

    • algorithm: string
    • key: Buffer

    Returns Hmac

createSign

  • createSign(algorithm: string): Signer
  • Parameters

    • algorithm: string

    Returns Signer

createVerify

  • createVerify(algorith: string): Verify
  • Parameters

    • algorith: string

    Returns Verify

getDiffieHellman

  • Parameters

    • group_name: string

    Returns DiffieHellman

pbkdf2

  • pbkdf2(password: string, salt: string, iterations: number, keylen: number, callback: function): void
  • pbkdf2(password: string, salt: string, iterations: number, keylen: number, digest: string, callback: function): void
  • Parameters

    • password: string
    • salt: string
    • iterations: number
    • keylen: number
    • callback: function
        • (err: Error, derivedKey: Buffer): any
        • Parameters

          • err: Error
          • derivedKey: Buffer

          Returns any

    Returns void

  • Parameters

    • password: string
    • salt: string
    • iterations: number
    • keylen: number
    • digest: string
    • callback: function
        • (err: Error, derivedKey: Buffer): any
        • Parameters

          • err: Error
          • derivedKey: Buffer

          Returns any

    Returns void

pbkdf2Sync

  • pbkdf2Sync(password: string, salt: string, iterations: number, keylen: number): Buffer
  • pbkdf2Sync(password: string, salt: string, iterations: number, keylen: number, digest: string): Buffer
  • Parameters

    • password: string
    • salt: string
    • iterations: number
    • keylen: number

    Returns Buffer

  • Parameters

    • password: string
    • salt: string
    • iterations: number
    • keylen: number
    • digest: string

    Returns Buffer

pseudoRandomBytes

  • pseudoRandomBytes(size: number): Buffer
  • pseudoRandomBytes(size: number, callback: function): void
  • Parameters

    • size: number

    Returns Buffer

  • Parameters

    • size: number
    • callback: function
        • (err: Error, buf: Buffer): void
        • Parameters

          Returns void

    Returns void

randomBytes

  • randomBytes(size: number): Buffer
  • randomBytes(size: number, callback: function): void
  • Parameters

    • size: number

    Returns Buffer

  • Parameters

    • size: number
    • callback: function
        • (err: Error, buf: Buffer): void
        • Parameters

          Returns void

    Returns void

"dgram"

"dgram":

AddressInfo

AddressInfo:

address

address: string

family

family: string

port

port: number

RemoteInfo

RemoteInfo:

address

address: string

port

port: number

size

size: number

Socket

Socket:

addListener

  • addListener(event: string, listener: Function): EventEmitter

addMembership

  • addMembership(multicastAddress: string, multicastInterface?: string): void
  • Parameters

    • multicastAddress: string
    • Optional multicastInterface: string

    Returns void

address

  • Returns AddressInfo

bind

  • bind(port: number, address?: string, callback?: function): void
  • Parameters

    • port: number
    • Optional address: string
    • Optional callback: function
        • (): void
        • Returns void

    Returns void

close

  • close(): void
  • Returns void

dropMembership

  • dropMembership(multicastAddress: string, multicastInterface?: string): void
  • Parameters

    • multicastAddress: string
    • Optional multicastInterface: string

    Returns void

emit

  • emit(event: string, ...args: any[]): boolean
  • Parameters

    • event: string
    • Rest ...args: any[]

    Returns boolean

listeners

  • listeners(event: string): Function[]
  • Parameters

    • event: string

    Returns Function[]

on

  • Parameters

    • event: string
    • listener: Function

    Returns EventEmitter

once

  • Parameters

    • event: string
    • listener: Function

    Returns EventEmitter

removeAllListeners

removeListener

  • removeListener(event: string, listener: Function): EventEmitter

send

  • send(buf: Buffer, offset: number, length: number, port: number, address: string, callback?: function): void
  • Parameters

    • buf: Buffer
    • offset: number
    • length: number
    • port: number
    • address: string
    • Optional callback: function
        • (error: Error, bytes: number): void
        • Parameters

          • error: Error
          • bytes: number

          Returns void

    Returns void

setBroadcast

  • setBroadcast(flag: boolean): void
  • Parameters

    • flag: boolean

    Returns void

setMaxListeners

  • setMaxListeners(n: number): void

setMulticastLoopback

  • setMulticastLoopback(flag: boolean): void
  • Parameters

    • flag: boolean

    Returns void

setMulticastTTL

  • setMulticastTTL(ttl: number): void
  • Parameters

    • ttl: number

    Returns void

listenerCount

  • listenerCount(emitter: EventEmitter, event: string): number

createSocket

  • createSocket(type: string, callback?: function): Socket
  • Parameters

    Returns Socket

"dns"

"dns":

lookup

  • lookup(domain: string, family: number, callback: function): string
  • lookup(domain: string, callback: function): string
  • Parameters

    • domain: string
    • family: number
    • callback: function
        • (err: Error, address: string, family: number): void
        • Parameters

          • err: Error
          • address: string
          • family: number

          Returns void

    Returns string

  • Parameters

    • domain: string
    • callback: function
        • (err: Error, address: string, family: number): void
        • Parameters

          • err: Error
          • address: string
          • family: number

          Returns void

    Returns string

resolve

  • resolve(domain: string, rrtype: string, callback: function): string[]
  • resolve(domain: string, callback: function): string[]
  • Parameters

    • domain: string
    • rrtype: string
    • callback: function
        • (err: Error, addresses: string[]): void
        • Parameters

          • err: Error
          • addresses: string[]

          Returns void

    Returns string[]

  • Parameters

    • domain: string
    • callback: function
        • (err: Error, addresses: string[]): void
        • Parameters

          • err: Error
          • addresses: string[]

          Returns void

    Returns string[]

resolve4

  • resolve4(domain: string, callback: function): string[]
  • Parameters

    • domain: string
    • callback: function
        • (err: Error, addresses: string[]): void
        • Parameters

          • err: Error
          • addresses: string[]

          Returns void

    Returns string[]

resolve6

  • resolve6(domain: string, callback: function): string[]
  • Parameters

    • domain: string
    • callback: function
        • (err: Error, addresses: string[]): void
        • Parameters

          • err: Error
          • addresses: string[]

          Returns void

    Returns string[]

resolveCname

  • resolveCname(domain: string, callback: function): string[]
  • Parameters

    • domain: string
    • callback: function
        • (err: Error, addresses: string[]): void
        • Parameters

          • err: Error
          • addresses: string[]

          Returns void

    Returns string[]

resolveMx

  • resolveMx(domain: string, callback: function): string[]
  • Parameters

    • domain: string
    • callback: function
        • (err: Error, addresses: string[]): void
        • Parameters

          • err: Error
          • addresses: string[]

          Returns void

    Returns string[]

resolveNs

  • resolveNs(domain: string, callback: function): string[]
  • Parameters

    • domain: string
    • callback: function
        • (err: Error, addresses: string[]): void
        • Parameters

          • err: Error
          • addresses: string[]

          Returns void

    Returns string[]

resolveSrv

  • resolveSrv(domain: string, callback: function): string[]
  • Parameters

    • domain: string
    • callback: function
        • (err: Error, addresses: string[]): void
        • Parameters

          • err: Error
          • addresses: string[]

          Returns void

    Returns string[]

resolveTxt

  • resolveTxt(domain: string, callback: function): string[]
  • Parameters

    • domain: string
    • callback: function
        • (err: Error, addresses: string[]): void
        • Parameters

          • err: Error
          • addresses: string[]

          Returns void

    Returns string[]

reverse

  • reverse(ip: string, callback: function): string[]
  • Parameters

    • ip: string
    • callback: function
        • (err: Error, domains: string[]): void
        • Parameters

          • err: Error
          • domains: string[]

          Returns void

    Returns string[]

"domain"

"domain":

Domain

Domain:

add

  • Parameters

    Returns void

addListener

  • addListener(event: string, listener: Function): Domain

bind

  • bind(cb: function): any
  • Parameters

    • cb: function
        • (err: Error, data: any): any
        • Parameters

          • err: Error
          • data: any

          Returns any

    Returns any

dispose

  • dispose(): void
  • Returns void

emit

  • emit(event: string, ...args: any[]): boolean
  • Parameters

    • event: string
    • Rest ...args: any[]

    Returns boolean

intercept

  • intercept(cb: function): any
  • Parameters

    • cb: function
        • (data: any): any
        • Parameters

          • data: any

          Returns any

    Returns any

listeners

  • listeners(event: string): Function[]

on

  • on(event: string, listener: Function): Domain
  • Parameters

    • event: string
    • listener: Function

    Returns Domain

once

  • once(event: string, listener: Function): Domain

remove

  • Parameters

    Returns void

removeAllListeners

  • removeAllListeners(event?: string): Domain

removeListener

  • removeListener(event: string, listener: Function): Domain

run

  • run(fn: Function): void
  • Parameters

    • fn: Function

    Returns void

setMaxListeners

  • setMaxListeners(n: number): void

listenerCount

  • listenerCount(emitter: EventEmitter, event: string): number

create

  • Returns Domain

"events"

"events":

EventEmitter

EventEmitter:

addListener

  • addListener(event: string, listener: Function): EventEmitter

emit

  • emit(event: string, ...args: any[]): boolean
  • Parameters

    • event: string
    • Rest ...args: any[]

    Returns boolean

listeners

  • listeners(event: string): Function[]
  • Parameters

    • event: string

    Returns Function[]

on

  • Parameters

    • event: string
    • listener: Function

    Returns EventEmitter

once

  • Parameters

    • event: string
    • listener: Function

    Returns EventEmitter

removeAllListeners

removeListener

  • removeListener(event: string, listener: Function): EventEmitter

setMaxListeners

  • setMaxListeners(n: number): void

listenerCount

  • listenerCount(emitter: EventEmitter, event: string): number
  • Parameters

    Returns number

"fs"

"fs":

FSWatcher

FSWatcher:

addListener

  • addListener(event: string, listener: Function): EventEmitter

close

  • close(): void
  • Returns void

emit

  • emit(event: string, ...args: any[]): boolean
  • Parameters

    • event: string
    • Rest ...args: any[]

    Returns boolean

listeners

  • listeners(event: string): Function[]
  • Parameters

    • event: string

    Returns Function[]

on

  • Parameters

    • event: string
    • listener: Function

    Returns EventEmitter

once

  • Parameters

    • event: string
    • listener: Function

    Returns EventEmitter

removeAllListeners

removeListener

  • removeListener(event: string, listener: Function): EventEmitter

setMaxListeners

  • setMaxListeners(n: number): void

listenerCount

  • listenerCount(emitter: EventEmitter, event: string): number

ReadStream

ReadStream:

constructor

readable

readable: boolean

_read

  • _read(size: number): void
  • Parameters

    • size: number

    Returns void

addListener

  • addListener(event: string, listener: Function): EventEmitter

close

  • close(): void
  • Returns void

emit

  • emit(event: string, ...args: any[]): boolean
  • Parameters

    • event: string
    • Rest ...args: any[]

    Returns boolean

listeners

  • listeners(event: string): Function[]
  • Parameters

    • event: string

    Returns Function[]

on

  • Parameters

    • event: string
    • listener: Function

    Returns EventEmitter

once

  • Parameters

    • event: string
    • listener: Function

    Returns EventEmitter

pause

  • pause(): void
  • Returns void

pipe

  • pipe<T>(destination: T, options?: object): T
  • Type parameters

    Parameters

    • destination: T
    • Optional options: object
      • Optional end?: boolean

    Returns T

push

  • push(chunk: any, encoding?: string): boolean
  • Parameters

    • chunk: any
    • Optional encoding: string

    Returns boolean

read

  • read(size?: number): string | Buffer
  • Parameters

    • Optional size: number

    Returns string | Buffer

removeAllListeners

removeListener

  • removeListener(event: string, listener: Function): EventEmitter

resume

  • resume(): void
  • Returns void

setEncoding

  • setEncoding(encoding: string): void
  • Parameters

    • encoding: string

    Returns void

setMaxListeners

  • setMaxListeners(n: number): void

unpipe

  • unpipe<T>(destination?: T): void
  • Type parameters

    Parameters

    • Optional destination: T

    Returns void

unshift

  • unshift(chunk: string): void
  • unshift(chunk: Buffer): void
  • Parameters

    • chunk: string

    Returns void

  • Parameters

    Returns void

wrap

listenerCount

  • listenerCount(emitter: EventEmitter, event: string): number

Stats

Stats:

atime

atime: Date

blksize

blksize: number

blocks

blocks: number

ctime

ctime: Date

dev

dev: number

gid

gid: number

ino

ino: number

mode

mode: number

mtime

mtime: Date

nlink

nlink: number

rdev

rdev: number

size

size: number

uid

uid: number

isBlockDevice

  • isBlockDevice(): boolean
  • Returns boolean

isCharacterDevice

  • isCharacterDevice(): boolean
  • Returns boolean

isDirectory

  • isDirectory(): boolean
  • Returns boolean

isFIFO

  • isFIFO(): boolean
  • Returns boolean

isFile

  • isFile(): boolean
  • Returns boolean

isSocket

  • isSocket(): boolean
  • Returns boolean

isSymbolicLink

  • isSymbolicLink(): boolean
  • Returns boolean

WriteStream

WriteStream:

constructor

bytesWritten

bytesWritten: number

writable

writable: boolean

_write

  • _write(data: Buffer, encoding: string, callback: Function): void
  • _write(data: string, encoding: string, callback: Function): void
  • Parameters

    • data: Buffer
    • encoding: string
    • callback: Function

    Returns void

  • Parameters

    • data: string
    • encoding: string
    • callback: Function

    Returns void

addListener

  • addListener(event: string, listener: Function): EventEmitter

close

  • close(): void
  • Returns void

emit

  • emit(event: string, ...args: any[]): boolean
  • Parameters

    • event: string
    • Rest ...args: any[]

    Returns boolean

end

  • end(): void
  • end(buffer: Buffer, cb?: Function): void
  • end(str: string, cb?: Function): void
  • end(str: string, encoding?: string, cb?: Function): void
  • Returns void

  • Parameters

    • buffer: Buffer
    • Optional cb: Function

    Returns void

  • Parameters

    • str: string
    • Optional cb: Function

    Returns void

  • Parameters

    • str: string
    • Optional encoding: string
    • Optional cb: Function

    Returns void

listeners

  • listeners(event: string): Function[]
  • Parameters

    • event: string

    Returns Function[]

on

  • Parameters

    • event: string
    • listener: Function

    Returns EventEmitter

once

  • Parameters

    • event: string
    • listener: Function

    Returns EventEmitter

removeAllListeners

removeListener

  • removeListener(event: string, listener: Function): EventEmitter

setMaxListeners

  • setMaxListeners(n: number): void

write

  • write(buffer: Buffer, cb?: Function): boolean
  • write(str: string, cb?: Function): boolean
  • write(str: string, encoding?: string, cb?: Function): boolean
  • Parameters

    • buffer: Buffer
    • Optional cb: Function

    Returns boolean

  • Parameters

    • str: string
    • Optional cb: Function

    Returns boolean

  • Parameters

    • str: string
    • Optional encoding: string
    • Optional cb: Function

    Returns boolean

listenerCount

  • listenerCount(emitter: EventEmitter, event: string): number

F_OK

F_OK: number

Constant for fs.access(). File is visible to the calling process.

R_OK

R_OK: number

Constant for fs.access(). File can be read by the calling process.

W_OK

W_OK: number

Constant for fs.access(). File can be written by the calling process.

X_OK

X_OK: number

Constant for fs.access(). File can be executed by the calling process.

access

  • access(path: string, callback: function): void
  • access(path: string, mode: number, callback: function): void
  • Tests a user's permissions for the file specified by path.

    Parameters

    Returns void

  • Parameters

    Returns void

accessSync

  • accessSync(path: string, mode?: number): void
  • Synchronous version of fs.access. This throws if any accessibility checks fail, and does nothing otherwise.

    Parameters

    • path: string
    • Optional mode: number

    Returns void

appendFile

  • appendFile(filename: string, data: any, options: object, callback?: function): void
  • appendFile(filename: string, data: any, options: object, callback?: function): void
  • appendFile(filename: string, data: any, callback?: function): void
  • Parameters

    • filename: string
    • data: any
    • options: object
      • Optional encoding?: string
      • Optional flag?: string
      • Optional mode?: number
    • Optional callback: function

    Returns void

  • Parameters

    • filename: string
    • data: any
    • options: object
      • Optional encoding?: string
      • Optional flag?: string
      • Optional mode?: string
    • Optional callback: function

    Returns void

  • Parameters

    Returns void

appendFileSync

  • appendFileSync(filename: string, data: any, options?: object): void
  • appendFileSync(filename: string, data: any, options?: object): void
  • Parameters

    • filename: string
    • data: any
    • Optional options: object
      • Optional encoding?: string
      • Optional flag?: string
      • Optional mode?: number

    Returns void

  • Parameters

    • filename: string
    • data: any
    • Optional options: object
      • Optional encoding?: string
      • Optional flag?: string
      • Optional mode?: string

    Returns void

chmod

  • chmod(path: string, mode: number, callback?: function): void
  • chmod(path: string, mode: string, callback?: function): void
  • Parameters

    Returns void

  • Parameters

    Returns void

chmodSync

  • chmodSync(path: string, mode: number): void
  • chmodSync(path: string, mode: string): void
  • Parameters

    • path: string
    • mode: number

    Returns void

  • Parameters

    • path: string
    • mode: string

    Returns void

chown

  • chown(path: string, uid: number, gid: number, callback?: function): void
  • Parameters

    • path: string
    • uid: number
    • gid: number
    • Optional callback: function

    Returns void

chownSync

  • chownSync(path: string, uid: number, gid: number): void
  • Parameters

    • path: string
    • uid: number
    • gid: number

    Returns void

close

  • close(fd: number, callback?: function): void
  • Parameters

    Returns void

closeSync

  • closeSync(fd: number): void
  • Parameters

    • fd: number

    Returns void

createReadStream

  • createReadStream(path: string, options?: object): ReadStream
  • createReadStream(path: string, options?: object): ReadStream
  • Parameters

    • path: string
    • Optional options: object
      • Optional bufferSize?: number
      • Optional encoding?: string
      • Optional fd?: string
      • Optional flags?: string
      • Optional mode?: number

    Returns ReadStream

  • Parameters

    • path: string
    • Optional options: object
      • Optional bufferSize?: number
      • Optional encoding?: string
      • Optional fd?: string
      • Optional flags?: string
      • Optional mode?: string

    Returns ReadStream

createWriteStream

  • createWriteStream(path: string, options?: object): WriteStream
  • Parameters

    • path: string
    • Optional options: object
      • Optional encoding?: string
      • Optional flags?: string
      • Optional string?: string

    Returns WriteStream

exists

  • exists(path: string, callback?: function): void
  • Parameters

    • path: string
    • Optional callback: function
        • (exists: boolean): void
        • Parameters

          • exists: boolean

          Returns void

    Returns void

existsSync

  • existsSync(path: string): boolean
  • Parameters

    • path: string

    Returns boolean

fchmod

  • fchmod(fd: number, mode: number, callback?: function): void
  • fchmod(fd: number, mode: string, callback?: function): void
  • Parameters

    Returns void

  • Parameters

    Returns void

fchmodSync

  • fchmodSync(fd: number, mode: number): void
  • fchmodSync(fd: number, mode: string): void
  • Parameters

    • fd: number
    • mode: number

    Returns void

  • Parameters

    • fd: number
    • mode: string

    Returns void

fchown

  • fchown(fd: number, uid: number, gid: number, callback?: function): void
  • Parameters

    • fd: number
    • uid: number
    • gid: number
    • Optional callback: function

    Returns void

fchownSync

  • fchownSync(fd: number, uid: number, gid: number): void
  • Parameters

    • fd: number
    • uid: number
    • gid: number

    Returns void

fstat

  • fstat(fd: number, callback?: function): void
  • Parameters

    Returns void

fstatSync

  • fstatSync(fd: number): Stats
  • Parameters

    • fd: number

    Returns Stats

fsync

  • fsync(fd: number, callback?: function): void
  • Parameters

    Returns void

fsyncSync

  • fsyncSync(fd: number): void
  • Parameters

    • fd: number

    Returns void

ftruncate

  • ftruncate(fd: number, callback?: function): void
  • ftruncate(fd: number, len: number, callback?: function): void
  • Parameters

    Returns void

  • Parameters

    Returns void

ftruncateSync

  • ftruncateSync(fd: number, len?: number): void
  • Parameters

    • fd: number
    • Optional len: number

    Returns void

futimes

  • futimes(fd: number, atime: number, mtime: number, callback?: function): void
  • futimes(fd: number, atime: Date, mtime: Date, callback?: function): void
  • Parameters

    • fd: number
    • atime: number
    • mtime: number
    • Optional callback: function

    Returns void

  • Parameters

    • fd: number
    • atime: Date
    • mtime: Date
    • Optional callback: function

    Returns void

futimesSync

  • futimesSync(fd: number, atime: number, mtime: number): void
  • futimesSync(fd: number, atime: Date, mtime: Date): void
  • Parameters

    • fd: number
    • atime: number
    • mtime: number

    Returns void

  • Parameters

    • fd: number
    • atime: Date
    • mtime: Date

    Returns void

lchmod

  • lchmod(path: string, mode: number, callback?: function): void
  • lchmod(path: string, mode: string, callback?: function): void
  • Parameters

    Returns void

  • Parameters

    Returns void

lchmodSync

  • lchmodSync(path: string, mode: number): void
  • lchmodSync(path: string, mode: string): void
  • Parameters

    • path: string
    • mode: number

    Returns void

  • Parameters

    • path: string
    • mode: string

    Returns void

lchown

  • lchown(path: string, uid: number, gid: number, callback?: function): void
  • Parameters

    • path: string
    • uid: number
    • gid: number
    • Optional callback: function

    Returns void

lchownSync

  • lchownSync(path: string, uid: number, gid: number): void
  • Parameters

    • path: string
    • uid: number
    • gid: number

    Returns void

link

  • link(srcpath: string, dstpath: string, callback?: function): void
  • Parameters

    • srcpath: string
    • dstpath: string
    • Optional callback: function

    Returns void

linkSync

  • linkSync(srcpath: string, dstpath: string): void
  • Parameters

    • srcpath: string
    • dstpath: string

    Returns void

lstat

  • lstat(path: string, callback?: function): void
  • Parameters

    Returns void

lstatSync

  • lstatSync(path: string): Stats
  • Parameters

    • path: string

    Returns Stats

mkdir

  • mkdir(path: string, callback?: function): void
  • mkdir(path: string, mode: number, callback?: function): void
  • mkdir(path: string, mode: string, callback?: function): void
  • Parameters

    Returns void

  • Parameters

    Returns void

  • Parameters

    Returns void

mkdirSync

  • mkdirSync(path: string, mode?: number): void
  • mkdirSync(path: string, mode?: string): void
  • Parameters

    • path: string
    • Optional mode: number

    Returns void

  • Parameters

    • path: string
    • Optional mode: string

    Returns void

open

  • open(path: string, flags: string, callback?: function): void
  • open(path: string, flags: string, mode: number, callback?: function): void
  • open(path: string, flags: string, mode: string, callback?: function): void
  • Parameters

    • path: string
    • flags: string
    • Optional callback: function

    Returns void

  • Parameters

    • path: string
    • flags: string
    • mode: number
    • Optional callback: function

    Returns void

  • Parameters

    • path: string
    • flags: string
    • mode: string
    • Optional callback: function

    Returns void

openSync

  • openSync(path: string, flags: string, mode?: number): number
  • openSync(path: string, flags: string, mode?: string): number
  • Parameters

    • path: string
    • flags: string
    • Optional mode: number

    Returns number

  • Parameters

    • path: string
    • flags: string
    • Optional mode: string

    Returns number

read

  • read(fd: number, buffer: Buffer, offset: number, length: number, position: number, callback?: function): void
  • Parameters

    • fd: number
    • buffer: Buffer
    • offset: number
    • length: number
    • position: number
    • Optional callback: function

    Returns void

readFile

  • readFile(filename: string, encoding: string, callback: function): void
  • readFile(filename: string, options: object, callback: function): void
  • readFile(filename: string, options: object, callback: function): void
  • readFile(filename: string, callback: function): void
  • Parameters

    • filename: string
    • encoding: string
    • callback: function

    Returns void

  • Parameters

    • filename: string
    • options: object
      • encoding: string
      • Optional flag?: string
    • callback: function

    Returns void

  • Parameters

    Returns void

  • Parameters

    Returns void

readFileSync

  • readFileSync(filename: string, encoding: string): string
  • readFileSync(filename: string, options: object): string
  • readFileSync(filename: string, options?: object): Buffer
  • Parameters

    • filename: string
    • encoding: string

    Returns string

  • Parameters

    • filename: string
    • options: object
      • encoding: string
      • Optional flag?: string

    Returns string

  • Parameters

    • filename: string
    • Optional options: object
      • Optional flag?: string

    Returns Buffer

readSync

  • readSync(fd: number, buffer: Buffer, offset: number, length: number, position: number): number
  • Parameters

    • fd: number
    • buffer: Buffer
    • offset: number
    • length: number
    • position: number

    Returns number

readdir

  • readdir(path: string, callback?: function): void
  • Parameters

    • path: string
    • Optional callback: function

    Returns void

readdirSync

  • readdirSync(path: string): string[]
  • Parameters

    • path: string

    Returns string[]

readlink

  • readlink(path: string, callback?: function): void
  • Parameters

    • path: string
    • Optional callback: function

    Returns void

readlinkSync

  • readlinkSync(path: string): string
  • Parameters

    • path: string

    Returns string

realpath

  • realpath(path: string, callback?: function): void
  • realpath(path: string, cache: object, callback: function): void
  • Parameters

    • path: string
    • Optional callback: function

    Returns void

  • Parameters

    • path: string
    • cache: object
      • [path: string]: string
    • callback: function

    Returns void

realpathSync

  • realpathSync(path: string, cache?: object): string
  • Parameters

    • path: string
    • Optional cache: object
      • [path: string]: string

    Returns string

rename

  • rename(oldPath: string, newPath: string, callback?: function): void
  • Asynchronous rename.

    Parameters

    • oldPath: string
    • newPath: string
    • Optional callback: function

      No arguments other than a possible exception are given to the completion callback.

    Returns void

renameSync

  • renameSync(oldPath: string, newPath: string): void
  • Synchronous rename

    Parameters

    • oldPath: string
    • newPath: string

    Returns void

rmdir

  • rmdir(path: string, callback?: function): void
  • Parameters

    Returns void

rmdirSync

  • rmdirSync(path: string): void
  • Parameters

    • path: string

    Returns void

stat

  • stat(path: string, callback?: function): void
  • Parameters

    Returns void

statSync

  • statSync(path: string): Stats
  • Parameters

    • path: string

    Returns Stats

symlink

  • symlink(srcpath: string, dstpath: string, type?: string, callback?: function): void
  • Parameters

    • srcpath: string
    • dstpath: string
    • Optional type: string
    • Optional callback: function

    Returns void

symlinkSync

  • symlinkSync(srcpath: string, dstpath: string, type?: string): void
  • Parameters

    • srcpath: string
    • dstpath: string
    • Optional type: string

    Returns void

truncate

  • truncate(path: string, callback?: function): void
  • truncate(path: string, len: number, callback?: function): void
  • Parameters

    Returns void

  • Parameters

    Returns void

truncateSync

  • truncateSync(path: string, len?: number): void
  • Parameters

    • path: string
    • Optional len: number

    Returns void

unlink

  • unlink(path: string, callback?: function): void
  • Parameters

    Returns void

unlinkSync

  • unlinkSync(path: string): void
  • Parameters

    • path: string

    Returns void

unwatchFile

  • unwatchFile(filename: string, listener?: function): void
  • Parameters

    • filename: string
    • Optional listener: function

    Returns void

utimes

  • utimes(path: string, atime: number, mtime: number, callback?: function): void
  • utimes(path: string, atime: Date, mtime: Date, callback?: function): void
  • Parameters

    • path: string
    • atime: number
    • mtime: number
    • Optional callback: function

    Returns void

  • Parameters

    • path: string
    • atime: Date
    • mtime: Date
    • Optional callback: function

    Returns void

utimesSync

  • utimesSync(path: string, atime: number, mtime: number): void
  • utimesSync(path: string, atime: Date, mtime: Date): void
  • Parameters

    • path: string
    • atime: number
    • mtime: number

    Returns void

  • Parameters

    • path: string
    • atime: Date
    • mtime: Date

    Returns void

watch

  • watch(filename: string, listener?: function): FSWatcher
  • watch(filename: string, options: object, listener?: function): FSWatcher
  • Parameters

    • filename: string
    • Optional listener: function
        • (event: string, filename: string): any
        • Parameters

          • event: string
          • filename: string

          Returns any

    Returns FSWatcher

  • Parameters

    • filename: string
    • options: object
      • Optional persistent?: boolean
    • Optional listener: function
        • (event: string, filename: string): any
        • Parameters

          • event: string
          • filename: string

          Returns any

    Returns FSWatcher

watchFile

  • watchFile(filename: string, listener: function): void
  • watchFile(filename: string, options: object, listener: function): void
  • Parameters

    • filename: string
    • listener: function

    Returns void

  • Parameters

    • filename: string
    • options: object
      • Optional interval?: number
      • Optional persistent?: boolean
    • listener: function

    Returns void

write

  • write(fd: number, buffer: Buffer, offset: number, length: number, position: number, callback?: function): void
  • write(fd: number, buffer: Buffer, offset: number, length: number, callback?: function): void
  • Parameters

    • fd: number
    • buffer: Buffer
    • offset: number
    • length: number
    • position: number
    • Optional callback: function

    Returns void

  • Parameters

    Returns void

writeFile

  • writeFile(filename: string, data: any, callback?: function): void
  • writeFile(filename: string, data: any, options: object, callback?: function): void
  • writeFile(filename: string, data: any, options: object, callback?: function): void
  • Parameters

    Returns void

  • Parameters

    • filename: string
    • data: any
    • options: object
      • Optional encoding?: string
      • Optional flag?: string
      • Optional mode?: number
    • Optional callback: function

    Returns void

  • Parameters

    • filename: string
    • data: any
    • options: object
      • Optional encoding?: string
      • Optional flag?: string
      • Optional mode?: string
    • Optional callback: function

    Returns void

writeFileSync

  • writeFileSync(filename: string, data: any, options?: object): void
  • writeFileSync(filename: string, data: any, options?: object): void
  • Parameters

    • filename: string
    • data: any
    • Optional options: object
      • Optional encoding?: string
      • Optional flag?: string
      • Optional mode?: number

    Returns void

  • Parameters

    • filename: string
    • data: any
    • Optional options: object
      • Optional encoding?: string
      • Optional flag?: string
      • Optional mode?: string

    Returns void

writeSync

  • writeSync(fd: number, buffer: Buffer, offset: number, length: number, position: number): number
  • Parameters

    • fd: number
    • buffer: Buffer
    • offset: number
    • length: number
    • position: number

    Returns number

"http"

"http":

Agent

Agent:

constructor

  • Parameters

    Returns Agent

maxSockets

maxSockets: number

requests

requests: any

sockets

sockets: any

destroy

  • destroy(): void
  • Destroy any sockets that are currently in use by the agent. It is usually not necessary to do this. However, if you are using an agent with KeepAlive enabled, then it is best to explicitly shut down the agent when you know that it will no longer be used. Otherwise, sockets may hang open for quite a long time before the server terminates them.

    Returns void

AgentOptions

AgentOptions:

keepAlive

keepAlive: boolean

Keep sockets around in a pool to be used by other requests in the future. Default = false

keepAliveMsecs

keepAliveMsecs: number

When using HTTP KeepAlive, how often to send TCP KeepAlive packets over sockets being kept alive. Default = 1000. Only relevant if keepAlive is set to true.

maxFreeSockets

maxFreeSockets: number

Maximum number of sockets to leave open in a free state. Only relevant if keepAlive is set to true. Default = 256.

maxSockets

maxSockets: number

Maximum number of sockets to allow per host. Default for Node 0.10 is 5, default for Node 0.12 is Infinity

ClientRequest

ClientRequest:

constructor

writable

writable: boolean

_write

  • _write(data: Buffer, encoding: string, callback: Function): void
  • _write(data: string, encoding: string, callback: Function): void
  • Parameters

    • data: Buffer
    • encoding: string
    • callback: Function

    Returns void

  • Parameters

    • data: string
    • encoding: string
    • callback: Function

    Returns void

abort

  • abort(): void
  • Returns void

addListener

  • addListener(event: string, listener: Function): EventEmitter

emit

  • emit(event: string, ...args: any[]): boolean
  • Parameters

    • event: string
    • Rest ...args: any[]

    Returns boolean

end

  • end(): void
  • end(buffer: Buffer, cb?: Function): void
  • end(str: string, cb?: Function): void
  • end(str: string, encoding?: string, cb?: Function): void
  • end(data?: any, encoding?: string): void
  • Returns void

  • Parameters

    • buffer: Buffer
    • Optional cb: Function

    Returns void

  • Parameters

    • str: string
    • Optional cb: Function

    Returns void

  • Parameters

    • str: string
    • Optional encoding: string
    • Optional cb: Function

    Returns void

  • Parameters

    • Optional data: any
    • Optional encoding: string

    Returns void

listeners

  • listeners(event: string): Function[]

on

once

removeAllListeners

removeListener

  • removeListener(event: string, listener: Function): EventEmitter

setMaxListeners

  • setMaxListeners(n: number): void

setNoDelay

  • setNoDelay(noDelay?: boolean): void
  • Parameters

    • Optional noDelay: boolean

    Returns void

setSocketKeepAlive

  • setSocketKeepAlive(enable?: boolean, initialDelay?: number): void
  • Parameters

    • Optional enable: boolean
    • Optional initialDelay: number

    Returns void

setTimeout

  • setTimeout(timeout: number, callback?: Function): void
  • Parameters

    • timeout: number
    • Optional callback: Function

    Returns void

write

  • write(buffer: Buffer): boolean
  • write(buffer: Buffer, cb?: Function): boolean
  • write(str: string, cb?: Function): boolean
  • write(str: string, encoding?: string, cb?: Function): boolean
  • write(str: string, encoding?: string, fd?: string): boolean
  • write(chunk: any, encoding?: string): void
  • Parameters

    Returns boolean

  • Parameters

    • buffer: Buffer
    • Optional cb: Function

    Returns boolean

  • Parameters

    • str: string
    • Optional cb: Function

    Returns boolean

  • Parameters

    • str: string
    • Optional encoding: string
    • Optional cb: Function

    Returns boolean

  • Parameters

    • str: string
    • Optional encoding: string
    • Optional fd: string

    Returns boolean

  • Parameters

    • chunk: any
    • Optional encoding: string

    Returns void

listenerCount

  • listenerCount(emitter: EventEmitter, event: string): number

ClientResponse

ClientResponse:
deprecated

Use IncomingMessage

constructor

headers

headers: any

httpVersion

httpVersion: string

method

method: string

Only valid for request obtained from http.Server.

rawHeaders

rawHeaders: string[]

rawTrailers

rawTrailers: any

readable

readable: boolean

socket

socket: Socket

statusCode

statusCode: number

Only valid for response obtained from http.ClientRequest.

statusMessage

statusMessage: string

Only valid for response obtained from http.ClientRequest.

trailers

trailers: any

url

url: string

Only valid for request obtained from http.Server.

_read

  • _read(size: number): void
  • Parameters

    • size: number

    Returns void

addListener

  • addListener(event: string, listener: Function): EventEmitter

emit

  • emit(event: string, ...args: any[]): boolean
  • Parameters

    • event: string
    • Rest ...args: any[]

    Returns boolean

listeners

  • listeners(event: string): Function[]
  • Parameters

    • event: string

    Returns Function[]

on

  • Parameters

    • event: string
    • listener: Function

    Returns EventEmitter

once

  • Parameters

    • event: string
    • listener: Function

    Returns EventEmitter

pause

  • pause(): void
  • Returns void

pipe

  • pipe<T>(destination: T, options?: object): T
  • Type parameters

    Parameters

    • destination: T
    • Optional options: object
      • Optional end?: boolean

    Returns T

push

  • push(chunk: any, encoding?: string): boolean
  • Parameters

    • chunk: any
    • Optional encoding: string

    Returns boolean

read

  • read(size?: number): string | Buffer
  • Parameters

    • Optional size: number

    Returns string | Buffer

removeAllListeners

removeListener

  • removeListener(event: string, listener: Function): EventEmitter

resume

  • resume(): void
  • Returns void

setEncoding

  • setEncoding(encoding: string): void
  • Parameters

    • encoding: string

    Returns void

setMaxListeners

  • setMaxListeners(n: number): void

setTimeout

  • setTimeout(msecs: number, callback: Function): Timer
  • Parameters

    • msecs: number
    • callback: Function

    Returns Timer

unpipe

  • unpipe<T>(destination?: T): void
  • Type parameters

    Parameters

    • Optional destination: T

    Returns void

unshift

  • unshift(chunk: string): void
  • unshift(chunk: Buffer): void
  • Parameters

    • chunk: string

    Returns void

  • Parameters

    Returns void

wrap

listenerCount

  • listenerCount(emitter: EventEmitter, event: string): number

IncomingMessage

IncomingMessage:

constructor

headers

headers: any

httpVersion

httpVersion: string

method

method: string

Only valid for request obtained from http.Server.

rawHeaders

rawHeaders: string[]

rawTrailers

rawTrailers: any

readable

readable: boolean

socket

socket: Socket

statusCode

statusCode: number

Only valid for response obtained from http.ClientRequest.

statusMessage

statusMessage: string

Only valid for response obtained from http.ClientRequest.

trailers

trailers: any

url

url: string

Only valid for request obtained from http.Server.

_read

  • _read(size: number): void
  • Parameters

    • size: number

    Returns void

addListener

  • addListener(event: string, listener: Function): EventEmitter

emit

  • emit(event: string, ...args: any[]): boolean
  • Parameters

    • event: string
    • Rest ...args: any[]

    Returns boolean

listeners

  • listeners(event: string): Function[]

on

once

pause

  • pause(): void
  • Returns void

pipe

  • pipe<T>(destination: T, options?: object): T
  • Type parameters

    Parameters

    • destination: T
    • Optional options: object
      • Optional end?: boolean

    Returns T

push

  • push(chunk: any, encoding?: string): boolean
  • Parameters

    • chunk: any
    • Optional encoding: string

    Returns boolean

read

  • read(size?: number): string | Buffer
  • Parameters

    • Optional size: number

    Returns string | Buffer

removeAllListeners

removeListener

  • removeListener(event: string, listener: Function): EventEmitter

resume

  • resume(): void
  • Returns void

setEncoding

  • setEncoding(encoding: string): void
  • Parameters

    • encoding: string

    Returns void

setMaxListeners

  • setMaxListeners(n: number): void

setTimeout

  • setTimeout(msecs: number, callback: Function): Timer
  • Parameters

    • msecs: number
    • callback: Function

    Returns Timer

unpipe

  • unpipe<T>(destination?: T): void
  • Type parameters

    Parameters

    • Optional destination: T

    Returns void

unshift

  • unshift(chunk: string): void
  • unshift(chunk: Buffer): void
  • Parameters

    • chunk: string

    Returns void

  • Parameters

    Returns void

wrap

listenerCount

  • listenerCount(emitter: EventEmitter, event: string): number

Server

Server:

maxHeadersCount

maxHeadersCount: number

addListener

  • addListener(event: string, listener: Function): EventEmitter

address

  • address(): object
  • Returns object

    • address: string
    • family: string
    • port: number

close

  • Parameters

    • Optional cb: any

    Returns Server

emit

  • emit(event: string, ...args: any[]): boolean
  • Parameters

    • event: string
    • Rest ...args: any[]

    Returns boolean

listen

  • listen(port: number, hostname?: string, backlog?: number, callback?: Function): Server
  • listen(port: number, hostname?: string, callback?: Function): Server
  • listen(path: string, callback?: Function): Server
  • listen(handle: any, listeningListener?: Function): Server
  • Parameters

    • port: number
    • Optional hostname: string
    • Optional backlog: number
    • Optional callback: Function

    Returns Server

  • Parameters

    • port: number
    • Optional hostname: string
    • Optional callback: Function

    Returns Server

  • Parameters

    • path: string
    • Optional callback: Function

    Returns Server

  • Parameters

    • handle: any
    • Optional listeningListener: Function

    Returns Server

listeners

  • listeners(event: string): Function[]
  • Parameters

    • event: string

    Returns Function[]

on

  • Parameters

    • event: string
    • listener: Function

    Returns EventEmitter

once

  • Parameters

    • event: string
    • listener: Function

    Returns EventEmitter

removeAllListeners

removeListener

  • removeListener(event: string, listener: Function): EventEmitter

setMaxListeners

  • setMaxListeners(n: number): void

listenerCount

  • listenerCount(emitter: EventEmitter, event: string): number

ServerRequest

ServerRequest:
deprecated

Use IncomingMessage

constructor

connection

connection: Socket

headers

headers: any

httpVersion

httpVersion: string

method

method: string

Only valid for request obtained from http.Server.

rawHeaders

rawHeaders: string[]

rawTrailers

rawTrailers: any

readable

readable: boolean

socket

socket: Socket

statusCode

statusCode: number

Only valid for response obtained from http.ClientRequest.

statusMessage

statusMessage: string

Only valid for response obtained from http.ClientRequest.

trailers

trailers: any

url

url: string

Only valid for request obtained from http.Server.

_read

  • _read(size: number): void
  • Parameters

    • size: number

    Returns void

addListener

  • addListener(event: string, listener: Function): EventEmitter

emit

  • emit(event: string, ...args: any[]): boolean
  • Parameters

    • event: string
    • Rest ...args: any[]

    Returns boolean

listeners

  • listeners(event: string): Function[]
  • Parameters

    • event: string

    Returns Function[]

on

  • Parameters

    • event: string
    • listener: Function

    Returns EventEmitter

once

  • Parameters

    • event: string
    • listener: Function

    Returns EventEmitter

pause

  • pause(): void
  • Returns void

pipe

  • pipe<T>(destination: T, options?: object): T
  • Type parameters

    Parameters

    • destination: T
    • Optional options: object
      • Optional end?: boolean

    Returns T

push

  • push(chunk: any, encoding?: string): boolean
  • Parameters

    • chunk: any
    • Optional encoding: string

    Returns boolean

read

  • read(size?: number): string | Buffer
  • Parameters

    • Optional size: number

    Returns string | Buffer

removeAllListeners

removeListener

  • removeListener(event: string, listener: Function): EventEmitter

resume

  • resume(): void
  • Returns void

setEncoding

  • setEncoding(encoding: string): void
  • Parameters

    • encoding: string

    Returns void

setMaxListeners

  • setMaxListeners(n: number): void

setTimeout

  • setTimeout(msecs: number, callback: Function): Timer
  • Parameters

    • msecs: number
    • callback: Function

    Returns Timer

unpipe

  • unpipe<T>(destination?: T): void
  • Type parameters

    Parameters

    • Optional destination: T

    Returns void

unshift

  • unshift(chunk: string): void
  • unshift(chunk: Buffer): void
  • Parameters

    • chunk: string

    Returns void

  • Parameters

    Returns void

wrap

listenerCount

  • listenerCount(emitter: EventEmitter, event: string): number

ServerResponse

ServerResponse:

constructor

sendDate

sendDate: boolean

statusCode

statusCode: number

statusMessage

statusMessage: string

writable

writable: boolean

_write

  • _write(data: Buffer, encoding: string, callback: Function): void
  • _write(data: string, encoding: string, callback: Function): void
  • Parameters

    • data: Buffer
    • encoding: string
    • callback: Function

    Returns void

  • Parameters

    • data: string
    • encoding: string
    • callback: Function

    Returns void

addListener

  • addListener(event: string, listener: Function): EventEmitter

addTrailers

  • addTrailers(headers: any): void
  • Parameters

    • headers: any

    Returns void

emit

  • emit(event: string, ...args: any[]): boolean
  • Parameters

    • event: string
    • Rest ...args: any[]

    Returns boolean

end

  • end(): void
  • end(buffer: Buffer, cb?: Function): void
  • end(str: string, cb?: Function): void
  • end(str: string, encoding?: string, cb?: Function): void
  • end(data?: any, encoding?: string): void
  • Returns void

  • Parameters

    • buffer: Buffer
    • Optional cb: Function

    Returns void

  • Parameters

    • str: string
    • Optional cb: Function

    Returns void

  • Parameters

    • str: string
    • Optional encoding: string
    • Optional cb: Function

    Returns void

  • Parameters

    • Optional data: any
    • Optional encoding: string

    Returns void

getHeader

  • getHeader(name: string): string
  • Parameters

    • name: string

    Returns string

listeners

  • listeners(event: string): Function[]

on

once

removeAllListeners

removeHeader

  • removeHeader(name: string): void
  • Parameters

    • name: string

    Returns void

removeListener

  • removeListener(event: string, listener: Function): EventEmitter

setHeader

  • setHeader(name: string, value: string): void
  • Parameters

    • name: string
    • value: string

    Returns void

setMaxListeners

  • setMaxListeners(n: number): void

write

  • write(buffer: Buffer): boolean
  • write(buffer: Buffer, cb?: Function): boolean
  • write(str: string, cb?: Function): boolean
  • write(str: string, encoding?: string, cb?: Function): boolean
  • write(str: string, encoding?: string, fd?: string): boolean
  • write(chunk: any, encoding?: string): any
  • Parameters

    Returns boolean

  • Parameters

    • buffer: Buffer
    • Optional cb: Function

    Returns boolean

  • Parameters

    • str: string
    • Optional cb: Function

    Returns boolean

  • Parameters

    • str: string
    • Optional encoding: string
    • Optional cb: Function

    Returns boolean

  • Parameters

    • str: string
    • Optional encoding: string
    • Optional fd: string

    Returns boolean

  • Parameters

    • chunk: any
    • Optional encoding: string

    Returns any

writeContinue

  • writeContinue(): void
  • Returns void

writeHead

  • writeHead(statusCode: number, reasonPhrase?: string, headers?: any): void
  • writeHead(statusCode: number, headers?: any): void
  • Parameters

    • statusCode: number
    • Optional reasonPhrase: string
    • Optional headers: any

    Returns void

  • Parameters

    • statusCode: number
    • Optional headers: any

    Returns void

listenerCount

  • listenerCount(emitter: EventEmitter, event: string): number

METHODS

METHODS: string[]

STATUS_CODES

STATUS_CODES: object

Type declaration

  • [errorCode: string]: string

globalAgent

globalAgent: Agent

createClient

  • createClient(port?: number, host?: string): any
  • Parameters

    • Optional port: number
    • Optional host: string

    Returns any

createServer

  • createServer(requestListener?: function): Server

get

request

"https"

"https":

Agent

Agent:

maxSockets

maxSockets: number

requests

requests: any

sockets

sockets: any

RequestOptions

RequestOptions:

agent

agent: any

auth

auth: string

ca

ca: any

cert

cert: any

ciphers

ciphers: string

headers

headers: any

host

host: string

hostname

hostname: string

key

key: any

method

method: string

passphrase

passphrase: string

path

path: string

pfx

pfx: any

port

port: number

rejectUnauthorized

rejectUnauthorized: boolean

Server

Server:

constructor

bufferSize

bufferSize: number

bytesRead

bytesRead: number

bytesWritten

bytesWritten: number

connections

connections: number

localAddress

localAddress: string

localPort

localPort: number

maxConnections

maxConnections: number

readable

readable: boolean

remoteAddress

remoteAddress: string

remoteFamily

remoteFamily: string

remotePort

remotePort: number

writable

writable: boolean

_read

  • _read(size: number): void
  • Parameters

    • size: number

    Returns void

_write

  • _write(data: Buffer, encoding: string, callback: Function): void
  • _write(data: string, encoding: string, callback: Function): void
  • Parameters

    • data: Buffer
    • encoding: string
    • callback: Function

    Returns void

  • Parameters

    • data: string
    • encoding: string
    • callback: Function

    Returns void

addContext

  • addContext(hostName: string, credentials: object): void
  • Parameters

    • hostName: string
    • credentials: object
      • ca: string
      • cert: string
      • key: string

    Returns void

addListener

  • addListener(event: string, listener: Function): EventEmitter

address

  • address(): object
  • Returns object

    • address: string
    • family: string
    • port: number

close

connect

  • connect(port: number, host?: string, connectionListener?: Function): void
  • connect(path: string, connectionListener?: Function): void
  • Parameters

    • port: number
    • Optional host: string
    • Optional connectionListener: Function

    Returns void

  • Parameters

    • path: string
    • Optional connectionListener: Function

    Returns void

destroy

  • destroy(): void
  • Returns void

emit

  • emit(event: string, ...args: any[]): boolean
  • Parameters

    • event: string
    • Rest ...args: any[]

    Returns boolean

end

  • end(): void
  • end(buffer: Buffer, cb?: Function): void
  • end(str: string, cb?: Function): void
  • end(str: string, encoding?: string, cb?: Function): void
  • end(data?: any, encoding?: string): void
  • Returns void

  • Parameters

    • buffer: Buffer
    • Optional cb: Function

    Returns void

  • Parameters

    • str: string
    • Optional cb: Function

    Returns void

  • Parameters

    • str: string
    • Optional encoding: string
    • Optional cb: Function

    Returns void

  • Parameters

    • Optional data: any
    • Optional encoding: string

    Returns void

listen

  • listen(port: number, host?: string, backlog?: number, listeningListener?: Function): Server
  • listen(path: string, listeningListener?: Function): Server
  • listen(handle: any, listeningListener?: Function): Server
  • listen(port: number, host?: string, callback?: Function): Server
  • Parameters

    • port: number
    • Optional host: string
    • Optional backlog: number
    • Optional listeningListener: Function

    Returns Server

  • Parameters

    • path: string
    • Optional listeningListener: Function

    Returns Server

  • Parameters

    • handle: any
    • Optional listeningListener: Function

    Returns Server

  • Parameters

    • port: number
    • Optional host: string
    • Optional callback: Function

    Returns Server

listeners

  • listeners(event: string): Function[]
  • Parameters

    • event: string

    Returns Function[]

on

  • Parameters

    • event: string
    • listener: Function

    Returns EventEmitter

once

  • Parameters

    • event: string
    • listener: Function

    Returns EventEmitter

pause

  • pause(): void
  • Returns void

pipe

  • pipe<T>(destination: T, options?: object): T
  • Type parameters

    Parameters

    • destination: T
    • Optional options: object
      • Optional end?: boolean

    Returns T

push

  • push(chunk: any, encoding?: string): boolean
  • Parameters

    • chunk: any
    • Optional encoding: string

    Returns boolean

read

  • read(size?: number): string | Buffer
  • Parameters

    • Optional size: number

    Returns string | Buffer

ref

  • ref(): void
  • Returns void

removeAllListeners

removeListener

  • removeListener(event: string, listener: Function): EventEmitter

resume

  • resume(): void

setEncoding

  • setEncoding(encoding?: string): void

setKeepAlive

  • setKeepAlive(enable?: boolean, initialDelay?: number): void
  • Parameters

    • Optional enable: boolean
    • Optional initialDelay: number

    Returns void

setMaxListeners

  • setMaxListeners(n: number): void

setNoDelay

  • setNoDelay(noDelay?: boolean): void
  • Parameters

    • Optional noDelay: boolean

    Returns void

setTimeout

  • setTimeout(timeout: number, callback?: Function): void
  • Parameters

    • timeout: number
    • Optional callback: Function

    Returns void

unpipe

  • unpipe<T>(destination?: T): void
  • Type parameters

    Parameters

    • Optional destination: T

    Returns void

unref

  • unref(): void
  • Returns void

unshift

  • unshift(chunk: string): void
  • unshift(chunk: Buffer): void
  • Parameters

    • chunk: string

    Returns void

  • Parameters

    Returns void

wrap

write

  • write(buffer: Buffer): boolean
  • write(buffer: Buffer, cb?: Function): boolean
  • write(str: string, cb?: Function): boolean
  • write(str: string, encoding?: string, cb?: Function): boolean
  • write(str: string, encoding?: string, fd?: string): boolean
  • write(data: any, encoding?: string, callback?: Function): void
  • Parameters

    Returns boolean

  • Parameters

    • buffer: Buffer
    • Optional cb: Function

    Returns boolean

  • Parameters

    • str: string
    • Optional cb: Function

    Returns boolean

  • Parameters

    • str: string
    • Optional encoding: string
    • Optional cb: Function

    Returns boolean

  • Parameters

    • str: string
    • Optional encoding: string
    • Optional fd: string

    Returns boolean

  • Parameters

    • data: any
    • Optional encoding: string
    • Optional callback: Function

    Returns void

listenerCount

  • listenerCount(emitter: EventEmitter, event: string): number

ServerOptions

ServerOptions:

NPNProtocols

NPNProtocols: any

SNICallback

SNICallback: function

Type declaration

    • (servername: string): any
    • Parameters

      • servername: string

      Returns any

ca

ca: any

cert

cert: any

ciphers

ciphers: string

crl

crl: any

honorCipherOrder

honorCipherOrder: boolean

key

key: any

passphrase

passphrase: string

pfx

pfx: any

rejectUnauthorized

rejectUnauthorized: boolean

requestCert

requestCert: boolean

globalAgent

globalAgent: Agent

createServer

  • Parameters

    Returns Server

get

request

"net"

"net":

Server

Server:

constructor

Socket

Socket: object

Type declaration

  • constructor: function
    • new __type(options?: object): __type
    • Parameters

      • Optional options: object
        • Optional allowHalfOpen?: boolean
        • Optional fd?: string
        • Optional type?: string

      Returns __type

bufferSize

bufferSize: number

bytesRead

bytesRead: number

bytesWritten

bytesWritten: number

connections

connections: number

localAddress

localAddress: string

localPort

localPort: number

maxConnections

maxConnections: number

readable

readable: boolean

remoteAddress

remoteAddress: string

remoteFamily

remoteFamily: string

remotePort

remotePort: number

writable

writable: boolean

_read

  • _read(size: number): void
  • Parameters

    • size: number

    Returns void

_write

  • _write(data: Buffer, encoding: string, callback: Function): void
  • _write(data: string, encoding: string, callback: Function): void
  • Parameters

    • data: Buffer
    • encoding: string
    • callback: Function

    Returns void

  • Parameters

    • data: string
    • encoding: string
    • callback: Function

    Returns void

addListener

  • addListener(event: string, listener: Function): EventEmitter

address

  • address(): object
  • Returns object

    • address: string
    • family: string
    • port: number

close

  • close(callback?: Function): Server
  • Parameters

    • Optional callback: Function

    Returns Server

connect

  • connect(port: number, host?: string, connectionListener?: Function): void
  • connect(path: string, connectionListener?: Function): void
  • Parameters

    • port: number
    • Optional host: string
    • Optional connectionListener: Function

    Returns void

  • Parameters

    • path: string
    • Optional connectionListener: Function

    Returns void

destroy

  • destroy(): void
  • Returns void

emit

  • emit(event: string, ...args: any[]): boolean
  • Parameters

    • event: string
    • Rest ...args: any[]

    Returns boolean

end

  • end(): void
  • end(buffer: Buffer, cb?: Function): void
  • end(str: string, cb?: Function): void
  • end(str: string, encoding?: string, cb?: Function): void
  • end(data?: any, encoding?: string): void
  • Returns void

  • Parameters

    • buffer: Buffer
    • Optional cb: Function

    Returns void

  • Parameters

    • str: string
    • Optional cb: Function

    Returns void

  • Parameters

    • str: string
    • Optional encoding: string
    • Optional cb: Function

    Returns void

  • Parameters

    • Optional data: any
    • Optional encoding: string

    Returns void

listen

  • listen(port: number, host?: string, backlog?: number, listeningListener?: Function): Server
  • listen(path: string, listeningListener?: Function): Server
  • listen(handle: any, listeningListener?: Function): Server
  • Parameters

    • port: number
    • Optional host: string
    • Optional backlog: number
    • Optional listeningListener: Function

    Returns Server

  • Parameters

    • path: string
    • Optional listeningListener: Function

    Returns Server

  • Parameters

    • handle: any
    • Optional listeningListener: Function

    Returns Server

listeners

  • listeners(event: string): Function[]
  • Parameters

    • event: string

    Returns Function[]

on

  • Parameters

    • event: string
    • listener: Function

    Returns EventEmitter

once

  • Parameters

    • event: string
    • listener: Function

    Returns EventEmitter

pause

  • pause(): void
  • Returns void

pipe

  • pipe<T>(destination: T, options?: object): T
  • Type parameters

    Parameters

    • destination: T
    • Optional options: object
      • Optional end?: boolean

    Returns T

push

  • push(chunk: any, encoding?: string): boolean
  • Parameters

    • chunk: any
    • Optional encoding: string

    Returns boolean

read

  • read(size?: number): string | Buffer
  • Parameters

    • Optional size: number

    Returns string | Buffer

ref

  • ref(): void
  • Returns void

removeAllListeners

removeListener

  • removeListener(event: string, listener: Function): EventEmitter

resume

  • resume(): void

setEncoding

  • setEncoding(encoding?: string): void

setKeepAlive

  • setKeepAlive(enable?: boolean, initialDelay?: number): void
  • Parameters

    • Optional enable: boolean
    • Optional initialDelay: number

    Returns void

setMaxListeners

  • setMaxListeners(n: number): void

setNoDelay

  • setNoDelay(noDelay?: boolean): void
  • Parameters

    • Optional noDelay: boolean

    Returns void

setTimeout

  • setTimeout(timeout: number, callback?: Function): void
  • Parameters

    • timeout: number
    • Optional callback: Function

    Returns void

unpipe

  • unpipe<T>(destination?: T): void
  • Type parameters

    Parameters

    • Optional destination: T

    Returns void

unref

  • unref(): void
  • Returns void

unshift

  • unshift(chunk: string): void
  • unshift(chunk: Buffer): void
  • Parameters

    • chunk: string

    Returns void

  • Parameters

    Returns void

wrap

write

  • write(buffer: Buffer): boolean
  • write(buffer: Buffer, cb?: Function): boolean
  • write(str: string, cb?: Function): boolean
  • write(str: string, encoding?: string, cb?: Function): boolean
  • write(str: string, encoding?: string, fd?: string): boolean
  • write(data: any, encoding?: string, callback?: Function): void
  • Parameters

    Returns boolean

  • Parameters

    • buffer: Buffer
    • Optional cb: Function

    Returns boolean

  • Parameters

    • str: string
    • Optional cb: Function

    Returns boolean

  • Parameters

    • str: string
    • Optional encoding: string
    • Optional cb: Function

    Returns boolean

  • Parameters

    • str: string
    • Optional encoding: string
    • Optional fd: string

    Returns boolean

  • Parameters

    • data: any
    • Optional encoding: string
    • Optional callback: Function

    Returns void

listenerCount

  • listenerCount(emitter: EventEmitter, event: string): number

Socket

Socket:

constructor

bufferSize

bufferSize: number

bytesRead

bytesRead: number

bytesWritten

bytesWritten: number

localAddress

localAddress: string

localPort

localPort: number

readable

readable: boolean

remoteAddress

remoteAddress: string

remoteFamily

remoteFamily: string

remotePort

remotePort: number

writable

writable: boolean

_read

  • _read(size: number): void
  • Parameters

    • size: number

    Returns void

_write

  • _write(data: Buffer, encoding: string, callback: Function): void
  • _write(data: string, encoding: string, callback: Function): void
  • Parameters

    • data: Buffer
    • encoding: string
    • callback: Function

    Returns void

  • Parameters

    • data: string
    • encoding: string
    • callback: Function

    Returns void

addListener

  • addListener(event: string, listener: Function): EventEmitter

address

  • address(): object
  • Returns object

    • address: string
    • family: string
    • port: number

connect

  • connect(port: number, host?: string, connectionListener?: Function): void
  • connect(path: string, connectionListener?: Function): void
  • Parameters

    • port: number
    • Optional host: string
    • Optional connectionListener: Function

    Returns void

  • Parameters

    • path: string
    • Optional connectionListener: Function

    Returns void

destroy

  • destroy(): void
  • Returns void

emit

  • emit(event: string, ...args: any[]): boolean
  • Parameters

    • event: string
    • Rest ...args: any[]

    Returns boolean

end

  • end(): void
  • end(buffer: Buffer, cb?: Function): void
  • end(str: string, cb?: Function): void
  • end(str: string, encoding?: string, cb?: Function): void
  • end(data?: any, encoding?: string): void
  • Returns void

  • Parameters

    • buffer: Buffer
    • Optional cb: Function

    Returns void

  • Parameters

    • str: string
    • Optional cb: Function

    Returns void

  • Parameters

    • str: string
    • Optional encoding: string
    • Optional cb: Function

    Returns void

  • Parameters

    • Optional data: any
    • Optional encoding: string

    Returns void

listeners

  • listeners(event: string): Function[]
  • Parameters

    • event: string

    Returns Function[]

on

  • Parameters

    • event: string
    • listener: Function

    Returns EventEmitter

once

  • Parameters

    • event: string
    • listener: Function

    Returns EventEmitter

pause

  • pause(): void
  • Returns void

pipe

  • pipe<T>(destination: T, options?: object): T
  • Type parameters

    Parameters

    • destination: T
    • Optional options: object
      • Optional end?: boolean

    Returns T

push

  • push(chunk: any, encoding?: string): boolean
  • Parameters

    • chunk: any
    • Optional encoding: string

    Returns boolean

read

  • read(size?: number): string | Buffer
  • Parameters

    • Optional size: number

    Returns string | Buffer

ref

  • ref(): void
  • Returns void

removeAllListeners

removeListener

  • removeListener(event: string, listener: Function): EventEmitter

resume

  • resume(): void
  • Returns void

setEncoding

  • setEncoding(encoding?: string): void
  • Parameters

    • Optional encoding: string

    Returns void

setKeepAlive

  • setKeepAlive(enable?: boolean, initialDelay?: number): void
  • Parameters

    • Optional enable: boolean
    • Optional initialDelay: number

    Returns void

setMaxListeners

  • setMaxListeners(n: number): void

setNoDelay

  • setNoDelay(noDelay?: boolean): void
  • Parameters

    • Optional noDelay: boolean

    Returns void

setTimeout

  • setTimeout(timeout: number, callback?: Function): void
  • Parameters

    • timeout: number
    • Optional callback: Function

    Returns void

unpipe

  • unpipe<T>(destination?: T): void
  • Type parameters

    Parameters

    • Optional destination: T

    Returns void

unref

  • unref(): void
  • Returns void

unshift

  • unshift(chunk: string): void
  • unshift(chunk: Buffer): void
  • Parameters

    • chunk: string

    Returns void

  • Parameters

    Returns void

wrap

write

  • write(buffer: Buffer): boolean
  • write(buffer: Buffer, cb?: Function): boolean
  • write(str: string, cb?: Function): boolean
  • write(str: string, encoding?: string, cb?: Function): boolean
  • write(str: string, encoding?: string, fd?: string): boolean
  • write(data: any, encoding?: string, callback?: Function): void
  • Parameters

    Returns boolean

  • Parameters

    • buffer: Buffer
    • Optional cb: Function

    Returns boolean

  • Parameters

    • str: string
    • Optional cb: Function

    Returns boolean

  • Parameters

    • str: string
    • Optional encoding: string
    • Optional cb: Function

    Returns boolean

  • Parameters

    • str: string
    • Optional encoding: string
    • Optional fd: string

    Returns boolean

  • Parameters

    • data: any
    • Optional encoding: string
    • Optional callback: Function

    Returns void

listenerCount

  • listenerCount(emitter: EventEmitter, event: string): number

connect

  • connect(options: object, connectionListener?: Function): Socket
  • connect(port: number, host?: string, connectionListener?: Function): Socket
  • connect(path: string, connectionListener?: Function): Socket
  • Parameters

    • options: object
      • Optional allowHalfOpen?: boolean
    • Optional connectionListener: Function

    Returns Socket

  • Parameters

    • port: number
    • Optional host: string
    • Optional connectionListener: Function

    Returns Socket

  • Parameters

    • path: string
    • Optional connectionListener: Function

    Returns Socket

createConnection

  • createConnection(options: object, connectionListener?: Function): Socket
  • createConnection(port: number, host?: string, connectionListener?: Function): Socket
  • createConnection(path: string, connectionListener?: Function): Socket
  • Parameters

    • options: object
      • Optional allowHalfOpen?: boolean
    • Optional connectionListener: Function

    Returns Socket

  • Parameters

    • port: number
    • Optional host: string
    • Optional connectionListener: Function

    Returns Socket

  • Parameters

    • path: string
    • Optional connectionListener: Function

    Returns Socket

createServer

  • createServer(connectionListener?: function): Server
  • createServer(options?: object, connectionListener?: function): Server
  • Parameters

    • Optional connectionListener: function
        • Parameters

          Returns void

    Returns Server

  • Parameters

    • Optional options: object
      • Optional allowHalfOpen?: boolean
    • Optional connectionListener: function
        • Parameters

          Returns void

    Returns Server

isIP

  • isIP(input: string): number
  • Parameters

    • input: string

    Returns number

isIPv4

  • isIPv4(input: string): boolean
  • Parameters

    • input: string

    Returns boolean

isIPv6

  • isIPv6(input: string): boolean
  • Parameters

    • input: string

    Returns boolean

"os"

"os":

EOL

EOL: string

arch

  • arch(): string
  • Returns string

cpus

  • cpus(): object[]
  • Returns object[]

    • model: string
    • speed: number
    • times: object
      • idle: number
      • irq: number
      • nice: number
      • sys: number
      • user: number

freemem

  • freemem(): number
  • Returns number

hostname

  • hostname(): string
  • Returns string

loadavg

  • loadavg(): number[]
  • Returns number[]

networkInterfaces

  • networkInterfaces(): any
  • Returns any

platform

  • platform(): string
  • Returns string

release

  • release(): string
  • Returns string

tmpdir

  • tmpdir(): string
  • Returns string

totalmem

  • totalmem(): number
  • Returns number

type

  • type(): string
  • Returns string

uptime

  • uptime(): number
  • Returns number

"path"

"path":

posix

posix:

delimiter

delimiter: string

sep

sep: string

basename

  • basename(p: string, ext?: string): string
  • Parameters

    • p: string
    • Optional ext: string

    Returns string

dirname

  • dirname(p: string): string
  • Parameters

    • p: string

    Returns string

extname

  • extname(p: string): string
  • Parameters

    • p: string

    Returns string

format

  • Parameters

    Returns string

isAbsolute

  • isAbsolute(p: string): boolean
  • Parameters

    • p: string

    Returns boolean

join

  • join(...paths: any[]): string
  • Parameters

    • Rest ...paths: any[]

    Returns string

normalize

  • normalize(p: string): string
  • Parameters

    • p: string

    Returns string

parse

  • Parameters

    • p: string

    Returns ParsedPath

relative

  • relative(from: string, to: string): string
  • Parameters

    • from: string
    • to: string

    Returns string

resolve

  • resolve(...pathSegments: any[]): string
  • Parameters

    • Rest ...pathSegments: any[]

    Returns string

win32

win32:

delimiter

delimiter: string

sep

sep: string

basename

  • basename(p: string, ext?: string): string
  • Parameters

    • p: string
    • Optional ext: string

    Returns string

dirname

  • dirname(p: string): string
  • Parameters

    • p: string

    Returns string

extname

  • extname(p: string): string
  • Parameters

    • p: string

    Returns string

format

  • Parameters

    Returns string

isAbsolute

  • isAbsolute(p: string): boolean
  • Parameters

    • p: string

    Returns boolean

join

  • join(...paths: any[]): string
  • Parameters

    • Rest ...paths: any[]

    Returns string

normalize

  • normalize(p: string): string
  • Parameters

    • p: string

    Returns string

parse

  • Parameters

    • p: string

    Returns ParsedPath

relative

  • relative(from: string, to: string): string
  • Parameters

    • from: string
    • to: string

    Returns string

resolve

  • resolve(...pathSegments: any[]): string
  • Parameters

    • Rest ...pathSegments: any[]

    Returns string

ParsedPath

ParsedPath:

A parsed path object generated by path.parse() or consumed by path.format().

base

base: string

The file name including extension (if any) such as 'index.html'

dir

dir: string

The full directory path such as '/home/user/dir' or 'c:\path\dir'

ext

ext: string

The file extension (if any) such as '.html'

name

name: string

The file name without extension (if any) such as 'index'

root

root: string

The root of the path such as '/' or 'c:\'

delimiter

delimiter: string

The platform-specific file delimiter. ';' or ':'.

sep

sep: string

The platform-specific file separator. '\' or '/'.

basename

  • basename(p: string, ext?: string): string
  • Return the last portion of a path. Similar to the Unix basename command. Often used to extract the file name from a fully qualified path.

    Parameters

    • p: string

      the path to evaluate.

    • Optional ext: string

      optionally, an extension to remove from the result.

    Returns string

dirname

  • dirname(p: string): string
  • Return the directory name of a path. Similar to the Unix dirname command.

    Parameters

    • p: string

      the path to evaluate.

    Returns string

extname

  • extname(p: string): string
  • Return the extension of the path, from the last '.' to end of string in the last portion of the path. If there is no '.' in the last portion of the path or the first character of it is '.', then it returns an empty string

    Parameters

    • p: string

      the path to evaluate.

    Returns string

format

  • Returns a path string from an object - the opposite of parse().

    Parameters

    Returns string

isAbsolute

  • isAbsolute(path: string): boolean
  • Determines whether {path} is an absolute path. An absolute path will always resolve to the same location, regardless of the working directory.

    Parameters

    • path: string

      path to test.

    Returns boolean

join

  • join(...paths: any[]): string
  • join(...paths: string[]): string
  • Join all arguments together and normalize the resulting path. Arguments must be strings. In v0.8, non-string arguments were silently ignored. In v0.10 and up, an exception is thrown.

    Parameters

    • Rest ...paths: any[]

      string paths to join.

    Returns string

  • Join all arguments together and normalize the resulting path. Arguments must be strings. In v0.8, non-string arguments were silently ignored. In v0.10 and up, an exception is thrown.

    Parameters

    • Rest ...paths: string[]

      string paths to join.

    Returns string

normalize

  • normalize(p: string): string
  • Normalize a string path, reducing '..' and '.' parts. When multiple slashes are found, they're replaced by a single one; when the path contains a trailing slash, it is preserved. On Windows backslashes are used.

    Parameters

    • p: string

      string path to normalize.

    Returns string

parse

  • Returns an object from a path string - the opposite of format().

    Parameters

    • pathString: string

      path to evaluate.

    Returns ParsedPath

relative

  • relative(from: string, to: string): string
  • Solve the relative path from {from} to {to}. At times we have two absolute paths, and we need to derive the relative path from one to the other. This is actually the reverse transform of path.resolve.

    Parameters

    • from: string
    • to: string

    Returns string

resolve

  • resolve(...pathSegments: any[]): string
  • The right-most parameter is considered {to}. Other parameters are considered an array of {from}.

    Starting from leftmost {from} paramter, resolves {to} to an absolute path.

    If {to} isn't already absolute, {from} arguments are prepended in right to left order, until an absolute path is found. If after using all {from} paths still no absolute path is found, the current working directory is used as well. The resulting path is normalized, and trailing slashes are removed unless the path gets resolved to the root directory.

    Parameters

    • Rest ...pathSegments: any[]

      string paths to join. Non-string arguments are ignored.

    Returns string

"punycode"

"punycode":

ucs2

ucs2:

decode

  • decode(string: string): string
  • Parameters

    • string: string

    Returns string

encode

  • encode(codePoints: number[]): string
  • Parameters

    • codePoints: number[]

    Returns string

version

version: any

decode

  • decode(string: string): string
  • Parameters

    • string: string

    Returns string

encode

  • encode(string: string): string
  • Parameters

    • string: string

    Returns string

toASCII

  • toASCII(domain: string): string
  • Parameters

    • domain: string

    Returns string

toUnicode

  • toUnicode(domain: string): string
  • Parameters

    • domain: string

    Returns string

"querystring"

"querystring":

escape

  • escape(str: string): string
  • Parameters

    • str: string

    Returns string

parse

  • parse(str: string, sep?: string, eq?: string, options?: object): any
  • Parameters

    • str: string
    • Optional sep: string
    • Optional eq: string
    • Optional options: object
      • Optional maxKeys?: number

    Returns any

stringify

  • stringify(obj: any, sep?: string, eq?: string): string
  • Parameters

    • obj: any
    • Optional sep: string
    • Optional eq: string

    Returns string

unescape

  • unescape(str: string): string
  • Parameters

    • str: string

    Returns string

"readline"

"readline":

ReadLine

ReadLine:

addListener

  • addListener(event: string, listener: Function): EventEmitter

close

  • close(): void
  • Returns void

emit

  • emit(event: string, ...args: any[]): boolean
  • Parameters

    • event: string
    • Rest ...args: any[]

    Returns boolean

listeners

  • listeners(event: string): Function[]
  • Parameters

    • event: string

    Returns Function[]

on

  • Parameters

    • event: string
    • listener: Function

    Returns EventEmitter

once

  • Parameters

    • event: string
    • listener: Function

    Returns EventEmitter

pause

  • pause(): void
  • Returns void

prompt

  • prompt(preserveCursor?: boolean): void
  • Parameters

    • Optional preserveCursor: boolean

    Returns void

question

  • question(query: string, callback: Function): void
  • Parameters

    • query: string
    • callback: Function

    Returns void

removeAllListeners

removeListener

  • removeListener(event: string, listener: Function): EventEmitter

resume

  • resume(): void
  • Returns void

setMaxListeners

  • setMaxListeners(n: number): void

setPrompt

  • setPrompt(prompt: string): void
  • Parameters

    • prompt: string

    Returns void

write

  • write(data: any, key?: any): void
  • Parameters

    • data: any
    • Optional key: any

    Returns void

listenerCount

  • listenerCount(emitter: EventEmitter, event: string): number

ReadLineOptions

ReadLineOptions:

completer

completer: Function

input

output

terminal

terminal: boolean

createInterface

"repl"

"repl":

ReplOptions

ReplOptions:

eval

eval: Function

ignoreUndefined

ignoreUndefined: boolean

input

output

prompt

prompt: string

terminal

terminal: boolean

useColors

useColors: boolean

useGlobal

useGlobal: boolean

writer

writer: Function

start

"stream"

"stream":

Duplex

Duplex:

constructor

readable

readable: boolean

writable

writable: boolean

_read

  • _read(size: number): void
  • Parameters

    • size: number

    Returns void

_write

  • _write(data: Buffer, encoding: string, callback: Function): void
  • _write(data: string, encoding: string, callback: Function): void
  • Parameters

    • data: Buffer
    • encoding: string
    • callback: Function

    Returns void

  • Parameters

    • data: string
    • encoding: string
    • callback: Function

    Returns void

addListener

  • addListener(event: string, listener: Function): EventEmitter

emit

  • emit(event: string, ...args: any[]): boolean
  • Parameters

    • event: string
    • Rest ...args: any[]

    Returns boolean

end

  • end(): void
  • end(buffer: Buffer, cb?: Function): void
  • end(str: string, cb?: Function): void
  • end(str: string, encoding?: string, cb?: Function): void
  • Returns void

  • Parameters

    • buffer: Buffer
    • Optional cb: Function

    Returns void

  • Parameters

    • str: string
    • Optional cb: Function

    Returns void

  • Parameters

    • str: string
    • Optional encoding: string
    • Optional cb: Function

    Returns void

listeners

  • listeners(event: string): Function[]

on

once

pause

  • pause(): void

pipe

  • pipe<T>(destination: T, options?: object): T
  • Type parameters

    Parameters

    • destination: T
    • Optional options: object
      • Optional end?: boolean

    Returns T

push

  • push(chunk: any, encoding?: string): boolean
  • Parameters

    • chunk: any
    • Optional encoding: string

    Returns boolean

read

  • read(size?: number): string | Buffer

removeAllListeners

removeListener

  • removeListener(event: string, listener: Function): EventEmitter

resume

  • resume(): void

setEncoding

  • setEncoding(encoding: string): void

setMaxListeners

  • setMaxListeners(n: number): void

unpipe

  • unpipe<T>(destination?: T): void

unshift

  • unshift(chunk: string): void
  • unshift(chunk: Buffer): void

wrap

write

  • write(buffer: Buffer, cb?: Function): boolean
  • write(str: string, cb?: Function): boolean
  • write(str: string, encoding?: string, cb?: Function): boolean
  • Parameters

    • buffer: Buffer
    • Optional cb: Function

    Returns boolean

  • Parameters

    • str: string
    • Optional cb: Function

    Returns boolean

  • Parameters

    • str: string
    • Optional encoding: string
    • Optional cb: Function

    Returns boolean

listenerCount

  • listenerCount(emitter: EventEmitter, event: string): number

PassThrough

PassThrough:

constructor

readable

readable: boolean

writable

writable: boolean

_flush

  • _flush(callback: Function): void
  • Parameters

    • callback: Function

    Returns void

_transform

  • _transform(chunk: Buffer, encoding: string, callback: Function): void
  • _transform(chunk: string, encoding: string, callback: Function): void
  • Parameters

    • chunk: Buffer
    • encoding: string
    • callback: Function

    Returns void

  • Parameters

    • chunk: string
    • encoding: string
    • callback: Function

    Returns void

addListener

  • addListener(event: string, listener: Function): EventEmitter

emit

  • emit(event: string, ...args: any[]): boolean
  • Parameters

    • event: string
    • Rest ...args: any[]

    Returns boolean

end

  • end(): void
  • end(buffer: Buffer, cb?: Function): void
  • end(str: string, cb?: Function): void
  • end(str: string, encoding?: string, cb?: Function): void
  • Returns void

  • Parameters

    • buffer: Buffer
    • Optional cb: Function

    Returns void

  • Parameters

    • str: string
    • Optional cb: Function

    Returns void

  • Parameters

    • str: string
    • Optional encoding: string
    • Optional cb: Function

    Returns void

listeners

  • listeners(event: string): Function[]

on

once

pause

  • pause(): void

pipe

  • pipe<T>(destination: T, options?: object): T
  • Type parameters

    Parameters

    • destination: T
    • Optional options: object
      • Optional end?: boolean

    Returns T

push

  • push(chunk: any, encoding?: string): boolean
  • Parameters

    • chunk: any
    • Optional encoding: string

    Returns boolean

read

  • read(size?: number): any
  • Parameters

    • Optional size: number

    Returns any

removeAllListeners

removeListener

  • removeListener(event: string, listener: Function): EventEmitter

resume

  • resume(): void

setEncoding

  • setEncoding(encoding: string): void

setMaxListeners

  • setMaxListeners(n: number): void

unpipe

  • unpipe<T>(destination?: T): void

unshift

  • unshift(chunk: string): void
  • unshift(chunk: Buffer): void

wrap

write

  • write(buffer: Buffer, cb?: Function): boolean
  • write(str: string, cb?: Function): boolean
  • write(str: string, encoding?: string, cb?: Function): boolean
  • Parameters

    • buffer: Buffer
    • Optional cb: Function

    Returns boolean

  • Parameters

    • str: string
    • Optional cb: Function

    Returns boolean

  • Parameters

    • str: string
    • Optional encoding: string
    • Optional cb: Function

    Returns boolean

listenerCount

  • listenerCount(emitter: EventEmitter, event: string): number

Readable

Readable:

constructor

readable

readable: boolean

_read

  • _read(size: number): void
  • Parameters

    • size: number

    Returns void

addListener

  • addListener(event: string, listener: Function): EventEmitter

emit

  • emit(event: string, ...args: any[]): boolean
  • Parameters

    • event: string
    • Rest ...args: any[]

    Returns boolean

listeners

  • listeners(event: string): Function[]

on

once

pause

  • pause(): void
  • Returns void

pipe

  • pipe<T>(destination: T, options?: object): T
  • Type parameters

    Parameters

    • destination: T
    • Optional options: object
      • Optional end?: boolean

    Returns T

push

  • push(chunk: any, encoding?: string): boolean
  • Parameters

    • chunk: any
    • Optional encoding: string

    Returns boolean

read

  • read(size?: number): string | Buffer
  • Parameters

    • Optional size: number

    Returns string | Buffer

removeAllListeners

removeListener

  • removeListener(event: string, listener: Function): EventEmitter

resume

  • resume(): void
  • Returns void

setEncoding

  • setEncoding(encoding: string): void
  • Parameters

    • encoding: string

    Returns void

setMaxListeners

  • setMaxListeners(n: number): void

unpipe

  • unpipe<T>(destination?: T): void
  • Type parameters

    Parameters

    • Optional destination: T

    Returns void

unshift

  • unshift(chunk: string): void
  • unshift(chunk: Buffer): void
  • Parameters

    • chunk: string

    Returns void

  • Parameters

    Returns void

wrap

listenerCount

  • listenerCount(emitter: EventEmitter, event: string): number

Transform

Transform:

constructor

readable

readable: boolean

writable

writable: boolean

_flush

  • _flush(callback: Function): void
  • Parameters

    • callback: Function

    Returns void

_transform

  • _transform(chunk: Buffer, encoding: string, callback: Function): void
  • _transform(chunk: string, encoding: string, callback: Function): void
  • Parameters

    • chunk: Buffer
    • encoding: string
    • callback: Function

    Returns void

  • Parameters

    • chunk: string
    • encoding: string
    • callback: Function

    Returns void

addListener

  • addListener(event: string, listener: Function): EventEmitter

emit

  • emit(event: string, ...args: any[]): boolean
  • Parameters

    • event: string
    • Rest ...args: any[]

    Returns boolean

end

  • end(): void
  • end(buffer: Buffer, cb?: Function): void
  • end(str: string, cb?: Function): void
  • end(str: string, encoding?: string, cb?: Function): void
  • Returns void

  • Parameters

    • buffer: Buffer
    • Optional cb: Function

    Returns void

  • Parameters

    • str: string
    • Optional cb: Function

    Returns void

  • Parameters

    • str: string
    • Optional encoding: string
    • Optional cb: Function

    Returns void

listeners

  • listeners(event: string): Function[]

on

once

pause

  • pause(): void
  • Returns void

pipe

  • pipe<T>(destination: T, options?: object): T
  • Type parameters

    Parameters

    • destination: T
    • Optional options: object
      • Optional end?: boolean

    Returns T

push

  • push(chunk: any, encoding?: string): boolean
  • Parameters

    • chunk: any
    • Optional encoding: string

    Returns boolean

read

  • read(size?: number): any
  • Parameters

    • Optional size: number

    Returns any

removeAllListeners

removeListener

  • removeListener(event: string, listener: Function): EventEmitter

resume

  • resume(): void
  • Returns void

setEncoding

  • setEncoding(encoding: string): void
  • Parameters

    • encoding: string

    Returns void

setMaxListeners

  • setMaxListeners(n: number): void

unpipe

  • unpipe<T>(destination?: T): void
  • Type parameters

    Parameters

    • Optional destination: T

    Returns void

unshift

  • unshift(chunk: string): void
  • unshift(chunk: Buffer): void
  • Parameters

    • chunk: string

    Returns void

  • Parameters

    Returns void

wrap

write

  • write(buffer: Buffer, cb?: Function): boolean
  • write(str: string, cb?: Function): boolean
  • write(str: string, encoding?: string, cb?: Function): boolean
  • Parameters

    • buffer: Buffer
    • Optional cb: Function

    Returns boolean

  • Parameters

    • str: string
    • Optional cb: Function

    Returns boolean

  • Parameters

    • str: string
    • Optional encoding: string
    • Optional cb: Function

    Returns boolean

listenerCount

  • listenerCount(emitter: EventEmitter, event: string): number

Writable

Writable:

constructor

writable

writable: boolean

_write

  • _write(data: Buffer, encoding: string, callback: Function): void
  • _write(data: string, encoding: string, callback: Function): void
  • Parameters

    • data: Buffer
    • encoding: string
    • callback: Function

    Returns void

  • Parameters

    • data: string
    • encoding: string
    • callback: Function

    Returns void

addListener

  • addListener(event: string, listener: Function): EventEmitter

emit

  • emit(event: string, ...args: any[]): boolean
  • Parameters

    • event: string
    • Rest ...args: any[]

    Returns boolean

end

  • end(): void
  • end(buffer: Buffer, cb?: Function): void
  • end(str: string, cb?: Function): void
  • end(str: string, encoding?: string, cb?: Function): void
  • Returns void

  • Parameters

    • buffer: Buffer
    • Optional cb: Function

    Returns void

  • Parameters

    • str: string
    • Optional cb: Function

    Returns void

  • Parameters

    • str: string
    • Optional encoding: string
    • Optional cb: Function

    Returns void

listeners

  • listeners(event: string): Function[]

on

once

removeAllListeners

removeListener

  • removeListener(event: string, listener: Function): EventEmitter

setMaxListeners

  • setMaxListeners(n: number): void

write

  • write(buffer: Buffer, cb?: Function): boolean
  • write(str: string, cb?: Function): boolean
  • write(str: string, encoding?: string, cb?: Function): boolean
  • Parameters

    • buffer: Buffer
    • Optional cb: Function

    Returns boolean

  • Parameters

    • str: string
    • Optional cb: Function

    Returns boolean

  • Parameters

    • str: string
    • Optional encoding: string
    • Optional cb: Function

    Returns boolean

listenerCount

  • listenerCount(emitter: EventEmitter, event: string): number

DuplexOptions

DuplexOptions:

allowHalfOpen

allowHalfOpen: boolean

decodeStrings

decodeStrings: boolean

encoding

encoding: string

highWaterMark

highWaterMark: number

objectMode

objectMode: boolean

ReadableOptions

ReadableOptions:

encoding

encoding: string

highWaterMark

highWaterMark: number

objectMode

objectMode: boolean

Stream

Stream:

addListener

  • addListener(event: string, listener: Function): EventEmitter

emit

  • emit(event: string, ...args: any[]): boolean
  • Parameters

    • event: string
    • Rest ...args: any[]

    Returns boolean

listeners

  • listeners(event: string): Function[]
  • Parameters

    • event: string

    Returns Function[]

on

  • Parameters

    • event: string
    • listener: Function

    Returns EventEmitter

once

  • Parameters

    • event: string
    • listener: Function

    Returns EventEmitter

pipe

  • pipe<T>(destination: T, options?: object): T
  • Type parameters

    Parameters

    • destination: T
    • Optional options: object
      • Optional end?: boolean

    Returns T

removeAllListeners

removeListener

  • removeListener(event: string, listener: Function): EventEmitter

setMaxListeners

  • setMaxListeners(n: number): void

listenerCount

  • listenerCount(emitter: EventEmitter, event: string): number

TransformOptions

TransformOptions:

decodeStrings

decodeStrings: boolean

encoding

encoding: string

highWaterMark

highWaterMark: number

objectMode

objectMode: boolean

WritableOptions

WritableOptions:

decodeStrings

decodeStrings: boolean

highWaterMark

highWaterMark: number

"string_decoder"

"string_decoder":

NodeStringDecoder

NodeStringDecoder:

detectIncompleteChar

  • detectIncompleteChar(buffer: Buffer): number
  • Parameters

    Returns number

write

  • write(buffer: Buffer): string
  • Parameters

    Returns string

StringDecoder

StringDecoder: object

Type declaration

  • constructor: function
    • new __type(encoding: string): __type
    • Parameters

      • encoding: string

      Returns __type

"tls"

"tls":

ClearTextStream

ClearTextStream:

constructor

address

address: object

Type declaration

  • address: string
  • family: string
  • port: number

authorizationError

authorizationError: Error

authorized

authorized: boolean

getCipher

getCipher: object

Type declaration

  • name: string
  • version: string

readable

readable: boolean

remoteAddress

remoteAddress: string

remotePort

remotePort: number

writable

writable: boolean

_read

  • _read(size: number): void
  • Parameters

    • size: number

    Returns void

_write

  • _write(data: Buffer, encoding: string, callback: Function): void
  • _write(data: string, encoding: string, callback: Function): void
  • Parameters

    • data: Buffer
    • encoding: string
    • callback: Function

    Returns void

  • Parameters

    • data: string
    • encoding: string
    • callback: Function

    Returns void

addListener

  • addListener(event: string, listener: Function): EventEmitter

emit

  • emit(event: string, ...args: any[]): boolean
  • Parameters

    • event: string
    • Rest ...args: any[]

    Returns boolean

end

  • end(): void
  • end(buffer: Buffer, cb?: Function): void
  • end(str: string, cb?: Function): void
  • end(str: string, encoding?: string, cb?: Function): void
  • Returns void

  • Parameters

    • buffer: Buffer
    • Optional cb: Function

    Returns void

  • Parameters

    • str: string
    • Optional cb: Function

    Returns void

  • Parameters

    • str: string
    • Optional encoding: string
    • Optional cb: Function

    Returns void

getPeerCertificate

  • getPeerCertificate(): any
  • Returns any

listeners

  • listeners(event: string): Function[]
  • Parameters

    • event: string

    Returns Function[]

on

  • Parameters

    • event: string
    • listener: Function

    Returns EventEmitter

once

  • Parameters

    • event: string
    • listener: Function

    Returns EventEmitter

pause

  • pause(): void
  • Returns void

pipe

  • pipe<T>(destination: T, options?: object): T
  • Type parameters

    Parameters

    • destination: T
    • Optional options: object
      • Optional end?: boolean

    Returns T

push

  • push(chunk: any, encoding?: string): boolean
  • Parameters

    • chunk: any
    • Optional encoding: string

    Returns boolean

read

  • read(size?: number): string | Buffer
  • Parameters

    • Optional size: number

    Returns string | Buffer

removeAllListeners

removeListener

  • removeListener(event: string, listener: Function): EventEmitter

resume

  • resume(): void
  • Returns void

setEncoding

  • setEncoding(encoding: string): void
  • Parameters

    • encoding: string

    Returns void

setMaxListeners

  • setMaxListeners(n: number): void

unpipe

  • unpipe<T>(destination?: T): void
  • Type parameters

    Parameters

    • Optional destination: T

    Returns void

unshift

  • unshift(chunk: string): void
  • unshift(chunk: Buffer): void
  • Parameters

    • chunk: string

    Returns void

  • Parameters

    Returns void

wrap

write

  • write(buffer: Buffer, cb?: Function): boolean
  • write(str: string, cb?: Function): boolean
  • write(str: string, encoding?: string, cb?: Function): boolean
  • Parameters

    • buffer: Buffer
    • Optional cb: Function

    Returns boolean

  • Parameters

    • str: string
    • Optional cb: Function

    Returns boolean

  • Parameters

    • str: string
    • Optional encoding: string
    • Optional cb: Function

    Returns boolean

listenerCount

  • listenerCount(emitter: EventEmitter, event: string): number

ConnectionOptions

ConnectionOptions:

NPNProtocols

NPNProtocols: any

ca

ca: any

cert

cert: any

host

host: string

key

key: any

passphrase

passphrase: string

pfx

pfx: any

port

port: number

rejectUnauthorized

rejectUnauthorized: boolean

servername

servername: string

socket

socket: Socket

SecureContext

SecureContext:

context

context: any

SecureContextOptions

SecureContextOptions:

ca

ca: any

cert

cert: any

ciphers

ciphers: string

crl

crl: any

honorCipherOrder

honorCipherOrder: boolean

key

key: any

passphrase

passphrase: string

pfx

pfx: any

SecurePair

SecurePair:

cleartext

cleartext: any

encrypted

encrypted: any

Server

Server:

constructor

bufferSize

bufferSize: number

bytesRead

bytesRead: number

bytesWritten

bytesWritten: number

connections

connections: number

localAddress

localAddress: string

localPort

localPort: number

maxConnections

maxConnections: number

readable

readable: boolean

remoteAddress

remoteAddress: string

remoteFamily

remoteFamily: string

remotePort

remotePort: number

writable

writable: boolean

_read

  • _read(size: number): void
  • Parameters

    • size: number

    Returns void

_write

  • _write(data: Buffer, encoding: string, callback: Function): void
  • _write(data: string, encoding: string, callback: Function): void
  • Parameters

    • data: Buffer
    • encoding: string
    • callback: Function

    Returns void

  • Parameters

    • data: string
    • encoding: string
    • callback: Function

    Returns void

addContext

  • addContext(hostName: string, credentials: object): void
  • Parameters

    • hostName: string
    • credentials: object
      • ca: string
      • cert: string
      • key: string

    Returns void

addListener

  • addListener(event: string, listener: Function): EventEmitter

address

  • address(): object
  • Returns object

    • address: string
    • family: string
    • port: number

close

  • Returns Server

connect

  • connect(port: number, host?: string, connectionListener?: Function): void
  • connect(path: string, connectionListener?: Function): void
  • Parameters

    • port: number
    • Optional host: string
    • Optional connectionListener: Function

    Returns void

  • Parameters

    • path: string
    • Optional connectionListener: Function

    Returns void

destroy

  • destroy(): void
  • Returns void

emit

  • emit(event: string, ...args: any[]): boolean
  • Parameters

    • event: string
    • Rest ...args: any[]

    Returns boolean

end

  • end(): void
  • end(buffer: Buffer, cb?: Function): void
  • end(str: string, cb?: Function): void
  • end(str: string, encoding?: string, cb?: Function): void
  • end(data?: any, encoding?: string): void
  • Returns void

  • Parameters

    • buffer: Buffer
    • Optional cb: Function

    Returns void

  • Parameters

    • str: string
    • Optional cb: Function

    Returns void

  • Parameters

    • str: string
    • Optional encoding: string
    • Optional cb: Function

    Returns void

  • Parameters

    • Optional data: any
    • Optional encoding: string

    Returns void

listen

  • listen(port: number, host?: string, backlog?: number, listeningListener?: Function): Server
  • listen(path: string, listeningListener?: Function): Server
  • listen(handle: any, listeningListener?: Function): Server
  • listen(port: number, host?: string, callback?: Function): Server
  • Parameters

    • port: number
    • Optional host: string
    • Optional backlog: number
    • Optional listeningListener: Function

    Returns Server

  • Parameters

    • path: string
    • Optional listeningListener: Function

    Returns Server

  • Parameters

    • handle: any
    • Optional listeningListener: Function

    Returns Server

  • Parameters

    • port: number
    • Optional host: string
    • Optional callback: Function

    Returns Server

listeners

  • listeners(event: string): Function[]
  • Parameters

    • event: string

    Returns Function[]

on

  • Parameters

    • event: string
    • listener: Function

    Returns EventEmitter

once

  • Parameters

    • event: string
    • listener: Function

    Returns EventEmitter

pause

  • pause(): void
  • Returns void

pipe

  • pipe<T>(destination: T, options?: object): T
  • Type parameters

    Parameters

    • destination: T
    • Optional options: object
      • Optional end?: boolean

    Returns T

push

  • push(chunk: any, encoding?: string): boolean
  • Parameters

    • chunk: any
    • Optional encoding: string

    Returns boolean

read

  • read(size?: number): string | Buffer
  • Parameters

    • Optional size: number

    Returns string | Buffer

ref

  • ref(): void
  • Returns void

removeAllListeners

removeListener

  • removeListener(event: string, listener: Function): EventEmitter

resume

  • resume(): void

setEncoding

  • setEncoding(encoding?: string): void

setKeepAlive

  • setKeepAlive(enable?: boolean, initialDelay?: number): void
  • Parameters

    • Optional enable: boolean
    • Optional initialDelay: number

    Returns void

setMaxListeners

  • setMaxListeners(n: number): void

setNoDelay

  • setNoDelay(noDelay?: boolean): void
  • Parameters

    • Optional noDelay: boolean

    Returns void

setTimeout

  • setTimeout(timeout: number, callback?: Function): void
  • Parameters

    • timeout: number
    • Optional callback: Function

    Returns void

unpipe

  • unpipe<T>(destination?: T): void
  • Type parameters

    Parameters

    • Optional destination: T

    Returns void

unref

  • unref(): void
  • Returns void

unshift

  • unshift(chunk: string): void
  • unshift(chunk: Buffer): void
  • Parameters

    • chunk: string

    Returns void

  • Parameters

    Returns void

wrap

write

  • write(buffer: Buffer): boolean
  • write(buffer: Buffer, cb?: Function): boolean
  • write(str: string, cb?: Function): boolean
  • write(str: string, encoding?: string, cb?: Function): boolean
  • write(str: string, encoding?: string, fd?: string): boolean
  • write(data: any, encoding?: string, callback?: Function): void
  • Parameters

    Returns boolean

  • Parameters

    • buffer: Buffer
    • Optional cb: Function

    Returns boolean

  • Parameters

    • str: string
    • Optional cb: Function

    Returns boolean

  • Parameters

    • str: string
    • Optional encoding: string
    • Optional cb: Function

    Returns boolean

  • Parameters

    • str: string
    • Optional encoding: string
    • Optional fd: string

    Returns boolean

  • Parameters

    • data: any
    • Optional encoding: string
    • Optional callback: Function

    Returns void

listenerCount

  • listenerCount(emitter: EventEmitter, event: string): number

TlsOptions

TlsOptions:

NPNProtocols

NPNProtocols: any

SNICallback

SNICallback: function

Type declaration

    • (servername: string): any
    • Parameters

      • servername: string

      Returns any

ca

ca: any

cert

cert: any

ciphers

ciphers: string

crl

crl: any

honorCipherOrder

honorCipherOrder: any

key

key: any

passphrase

passphrase: string

pfx

pfx: any

rejectUnauthorized

rejectUnauthorized: boolean

requestCert

requestCert: boolean

CLIENT_RENEG_LIMIT

CLIENT_RENEG_LIMIT: number

CLIENT_RENEG_WINDOW

CLIENT_RENEG_WINDOW: number

connect

  • Parameters

    • options: TlsOptions
    • Optional secureConnectionListener: function
        • (): void
        • Returns void

    Returns ClearTextStream

  • Parameters

    • port: number
    • Optional host: string
    • Optional options: ConnectionOptions
    • Optional secureConnectListener: function
        • (): void
        • Returns void

    Returns ClearTextStream

  • Parameters

    • port: number
    • Optional options: ConnectionOptions
    • Optional secureConnectListener: function
        • (): void
        • Returns void

    Returns ClearTextStream

createSecureContext

createSecurePair

  • createSecurePair(credentials?: Credentials, isServer?: boolean, requestCert?: boolean, rejectUnauthorized?: boolean): SecurePair
  • Parameters

    • Optional credentials: Credentials
    • Optional isServer: boolean
    • Optional requestCert: boolean
    • Optional rejectUnauthorized: boolean

    Returns SecurePair

createServer

  • createServer(options: TlsOptions, secureConnectionListener?: function): Server
  • Parameters

    Returns Server

"tty"

"tty":

ReadStream

ReadStream:

constructor

Socket

Socket: object

Type declaration

  • constructor: function
    • new __type(options?: object): __type
    • Parameters

      • Optional options: object
        • Optional allowHalfOpen?: boolean
        • Optional fd?: string
        • Optional type?: string

      Returns __type

bufferSize

bufferSize: number

bytesRead

bytesRead: number

bytesWritten

bytesWritten: number

isRaw

isRaw: boolean

localAddress

localAddress: string

localPort

localPort: number

readable

readable: boolean

remoteAddress

remoteAddress: string

remoteFamily

remoteFamily: string

remotePort

remotePort: number

writable

writable: boolean

_read

  • _read(size: number): void
  • Parameters

    • size: number

    Returns void

_write

  • _write(data: Buffer, encoding: string, callback: Function): void
  • _write(data: string, encoding: string, callback: Function): void
  • Parameters

    • data: Buffer
    • encoding: string
    • callback: Function

    Returns void

  • Parameters

    • data: string
    • encoding: string
    • callback: Function

    Returns void

addListener

  • addListener(event: string, listener: Function): EventEmitter

address

  • address(): object
  • Returns object

    • address: string
    • family: string
    • port: number

connect

  • connect(port: number, host?: string, connectionListener?: Function): void
  • connect(path: string, connectionListener?: Function): void
  • Parameters

    • port: number
    • Optional host: string
    • Optional connectionListener: Function

    Returns void

  • Parameters

    • path: string
    • Optional connectionListener: Function

    Returns void

destroy

  • destroy(): void
  • Returns void

emit

  • emit(event: string, ...args: any[]): boolean
  • Parameters

    • event: string
    • Rest ...args: any[]

    Returns boolean

end

  • end(): void
  • end(buffer: Buffer, cb?: Function): void
  • end(str: string, cb?: Function): void
  • end(str: string, encoding?: string, cb?: Function): void
  • end(data?: any, encoding?: string): void
  • Returns void

  • Parameters

    • buffer: Buffer
    • Optional cb: Function

    Returns void

  • Parameters

    • str: string
    • Optional cb: Function

    Returns void

  • Parameters

    • str: string
    • Optional encoding: string
    • Optional cb: Function

    Returns void

  • Parameters

    • Optional data: any
    • Optional encoding: string

    Returns void

listeners

  • listeners(event: string): Function[]
  • Parameters

    • event: string

    Returns Function[]

on

  • Parameters

    • event: string
    • listener: Function

    Returns EventEmitter

once

  • Parameters

    • event: string
    • listener: Function

    Returns EventEmitter

pause

  • pause(): void
  • Returns void

pipe

  • pipe<T>(destination: T, options?: object): T
  • Type parameters

    Parameters

    • destination: T
    • Optional options: object
      • Optional end?: boolean

    Returns T

push

  • push(chunk: any, encoding?: string): boolean
  • Parameters

    • chunk: any
    • Optional encoding: string

    Returns boolean

read

  • read(size?: number): string | Buffer
  • Parameters

    • Optional size: number

    Returns string | Buffer

ref

  • ref(): void
  • Returns void

removeAllListeners

removeListener

  • removeListener(event: string, listener: Function): EventEmitter

resume

  • resume(): void

setEncoding

  • setEncoding(encoding?: string): void

setKeepAlive

  • setKeepAlive(enable?: boolean, initialDelay?: number): void
  • Parameters

    • Optional enable: boolean
    • Optional initialDelay: number

    Returns void

setMaxListeners

  • setMaxListeners(n: number): void

setNoDelay

  • setNoDelay(noDelay?: boolean): void
  • Parameters

    • Optional noDelay: boolean

    Returns void

setRawMode

  • setRawMode(mode: boolean): void
  • Parameters

    • mode: boolean

    Returns void

setTimeout

  • setTimeout(timeout: number, callback?: Function): void
  • Parameters

    • timeout: number
    • Optional callback: Function

    Returns void

unpipe

  • unpipe<T>(destination?: T): void
  • Type parameters

    Parameters

    • Optional destination: T

    Returns void

unref

  • unref(): void
  • Returns void

unshift

  • unshift(chunk: string): void
  • unshift(chunk: Buffer): void
  • Parameters

    • chunk: string

    Returns void

  • Parameters

    Returns void

wrap

write

  • write(buffer: Buffer): boolean
  • write(buffer: Buffer, cb?: Function): boolean
  • write(str: string, cb?: Function): boolean
  • write(str: string, encoding?: string, cb?: Function): boolean
  • write(str: string, encoding?: string, fd?: string): boolean
  • write(data: any, encoding?: string, callback?: Function): void
  • Parameters

    Returns boolean

  • Parameters

    • buffer: Buffer
    • Optional cb: Function

    Returns boolean

  • Parameters

    • str: string
    • Optional cb: Function

    Returns boolean

  • Parameters

    • str: string
    • Optional encoding: string
    • Optional cb: Function

    Returns boolean

  • Parameters

    • str: string
    • Optional encoding: string
    • Optional fd: string

    Returns boolean

  • Parameters

    • data: any
    • Optional encoding: string
    • Optional callback: Function

    Returns void

listenerCount

  • listenerCount(emitter: EventEmitter, event: string): number

WriteStream

WriteStream:

constructor

Socket

Socket: object

Type declaration

  • constructor: function
    • new __type(options?: object): __type
    • Parameters

      • Optional options: object
        • Optional allowHalfOpen?: boolean
        • Optional fd?: string
        • Optional type?: string

      Returns __type

bufferSize

bufferSize: number

bytesRead

bytesRead: number

bytesWritten

bytesWritten: number

columns

columns: number

localAddress

localAddress: string

localPort

localPort: number

readable

readable: boolean

remoteAddress

remoteAddress: string

remoteFamily

remoteFamily: string

remotePort

remotePort: number

rows

rows: number

writable

writable: boolean

_read

  • _read(size: number): void
  • Parameters

    • size: number

    Returns void

_write

  • _write(data: Buffer, encoding: string, callback: Function): void
  • _write(data: string, encoding: string, callback: Function): void
  • Parameters

    • data: Buffer
    • encoding: string
    • callback: Function

    Returns void

  • Parameters

    • data: string
    • encoding: string
    • callback: Function

    Returns void

addListener

  • addListener(event: string, listener: Function): EventEmitter

address

  • address(): object
  • Returns object

    • address: string
    • family: string
    • port: number

connect

  • connect(port: number, host?: string, connectionListener?: Function): void
  • connect(path: string, connectionListener?: Function): void
  • Parameters

    • port: number
    • Optional host: string
    • Optional connectionListener: Function

    Returns void

  • Parameters

    • path: string
    • Optional connectionListener: Function

    Returns void

destroy

  • destroy(): void
  • Returns void

emit

  • emit(event: string, ...args: any[]): boolean
  • Parameters

    • event: string
    • Rest ...args: any[]

    Returns boolean

end

  • end(): void
  • end(buffer: Buffer, cb?: Function): void
  • end(str: string, cb?: Function): void
  • end(str: string, encoding?: string, cb?: Function): void
  • end(data?: any, encoding?: string): void
  • Returns void

  • Parameters

    • buffer: Buffer
    • Optional cb: Function

    Returns void

  • Parameters

    • str: string
    • Optional cb: Function

    Returns void

  • Parameters

    • str: string
    • Optional encoding: string
    • Optional cb: Function

    Returns void

  • Parameters

    • Optional data: any
    • Optional encoding: string

    Returns void

listeners

  • listeners(event: string): Function[]
  • Parameters

    • event: string

    Returns Function[]

on

  • Parameters

    • event: string
    • listener: Function

    Returns EventEmitter

once

  • Parameters

    • event: string
    • listener: Function

    Returns EventEmitter

pause

  • pause(): void
  • Returns void

pipe

  • pipe<T>(destination: T, options?: object): T
  • Type parameters

    Parameters

    • destination: T
    • Optional options: object
      • Optional end?: boolean

    Returns T

push

  • push(chunk: any, encoding?: string): boolean
  • Parameters

    • chunk: any
    • Optional encoding: string

    Returns boolean

read

  • read(size?: number): string | Buffer
  • Parameters

    • Optional size: number

    Returns string | Buffer

ref

  • ref(): void
  • Returns void

removeAllListeners

removeListener

  • removeListener(event: string, listener: Function): EventEmitter

resume

  • resume(): void

setEncoding

  • setEncoding(encoding?: string): void

setKeepAlive

  • setKeepAlive(enable?: boolean, initialDelay?: number): void
  • Parameters

    • Optional enable: boolean
    • Optional initialDelay: number

    Returns void

setMaxListeners

  • setMaxListeners(n: number): void

setNoDelay

  • setNoDelay(noDelay?: boolean): void
  • Parameters

    • Optional noDelay: boolean

    Returns void

setTimeout

  • setTimeout(timeout: number, callback?: Function): void
  • Parameters

    • timeout: number
    • Optional callback: Function

    Returns void

unpipe

  • unpipe<T>(destination?: T): void
  • Type parameters

    Parameters

    • Optional destination: T

    Returns void

unref

  • unref(): void
  • Returns void

unshift

  • unshift(chunk: string): void
  • unshift(chunk: Buffer): void
  • Parameters

    • chunk: string

    Returns void

  • Parameters

    Returns void

wrap

write

  • write(buffer: Buffer): boolean
  • write(buffer: Buffer, cb?: Function): boolean
  • write(str: string, cb?: Function): boolean
  • write(str: string, encoding?: string, cb?: Function): boolean
  • write(str: string, encoding?: string, fd?: string): boolean
  • write(data: any, encoding?: string, callback?: Function): void
  • Parameters

    Returns boolean

  • Parameters

    • buffer: Buffer
    • Optional cb: Function

    Returns boolean

  • Parameters

    • str: string
    • Optional cb: Function

    Returns boolean

  • Parameters

    • str: string
    • Optional encoding: string
    • Optional cb: Function

    Returns boolean

  • Parameters

    • str: string
    • Optional encoding: string
    • Optional fd: string

    Returns boolean

  • Parameters

    • data: any
    • Optional encoding: string
    • Optional callback: Function

    Returns void

listenerCount

  • listenerCount(emitter: EventEmitter, event: string): number

isatty

  • isatty(fd: number): boolean
  • Parameters

    • fd: number

    Returns boolean

"url"

"url":

Url

Url:

auth

auth: string

hash

hash: string

host

host: string

hostname

hostname: string

href

href: string

path

path: string

pathname

pathname: string

port

port: string

protocol

protocol: string

query

query: any

search

search: string

slashes

slashes: boolean

UrlOptions

UrlOptions:

auth

auth: string

hash

hash: string

host

host: string

hostname

hostname: string

path

path: string

pathname

pathname: string

port

port: string

protocol

protocol: string

query

query: any

search

search: string

format

  • Parameters

    Returns string

parse

  • parse(urlStr: string, parseQueryString?: boolean, slashesDenoteHost?: boolean): Url
  • Parameters

    • urlStr: string
    • Optional parseQueryString: boolean
    • Optional slashesDenoteHost: boolean

    Returns Url

resolve

  • resolve(from: string, to: string): string
  • Parameters

    • from: string
    • to: string

    Returns string

"util"

"util":

InspectOptions

InspectOptions:

colors

colors: boolean

customInspect

customInspect: boolean

depth

depth: number

showHidden

showHidden: boolean

debug

  • debug(string: string): void
  • Parameters

    • string: string

    Returns void

error

  • error(...param: any[]): void
  • Parameters

    • Rest ...param: any[]

    Returns void

format

  • format(format: any, ...param: any[]): string
  • Parameters

    • format: any
    • Rest ...param: any[]

    Returns string

inherits

  • inherits(constructor: any, superConstructor: any): void
  • Parameters

    • constructor: any
    • superConstructor: any

    Returns void

inspect

  • inspect(object: any, showHidden?: boolean, depth?: number, color?: boolean): string
  • inspect(object: any, options: InspectOptions): string
  • Parameters

    • object: any
    • Optional showHidden: boolean
    • Optional depth: number
    • Optional color: boolean

    Returns string

  • Parameters

    Returns string

isArray

  • isArray(object: any): boolean
  • Parameters

    • object: any

    Returns boolean

isDate

  • isDate(object: any): boolean
  • Parameters

    • object: any

    Returns boolean

isError

  • isError(object: any): boolean
  • Parameters

    • object: any

    Returns boolean

isRegExp

  • isRegExp(object: any): boolean
  • Parameters

    • object: any

    Returns boolean

log

  • log(string: string): void
  • Parameters

    • string: string

    Returns void

print

  • print(...param: any[]): void
  • Parameters

    • Rest ...param: any[]

    Returns void

puts

  • puts(...param: any[]): void
  • Parameters

    • Rest ...param: any[]

    Returns void

"vm"

"vm":

Context

Context:

Script

Script:

runInNewContext

  • runInNewContext(sandbox?: Context): void
  • Parameters

    Returns void

runInThisContext

  • runInThisContext(): void
  • Returns void

createContext

  • Parameters

    Returns Context

createScript

  • createScript(code: string, filename?: string): Script
  • Parameters

    • code: string
    • Optional filename: string

    Returns Script

runInContext

  • runInContext(code: string, context: Context, filename?: string): void
  • Parameters

    • code: string
    • context: Context
    • Optional filename: string

    Returns void

runInNewContext

  • runInNewContext(code: string, sandbox?: Context, filename?: string): void
  • Parameters

    • code: string
    • Optional sandbox: Context
    • Optional filename: string

    Returns void

runInThisContext

  • runInThisContext(code: string, filename?: string): void
  • Parameters

    • code: string
    • Optional filename: string

    Returns void

"zlib"

"zlib":

Deflate

Deflate:

constructor

readable

readable: boolean

writable

writable: boolean

_flush

  • _flush(callback: Function): void
  • Parameters

    • callback: Function

    Returns void

_transform

  • _transform(chunk: Buffer, encoding: string, callback: Function): void
  • _transform(chunk: string, encoding: string, callback: Function): void
  • Parameters

    • chunk: Buffer
    • encoding: string
    • callback: Function

    Returns void

  • Parameters

    • chunk: string
    • encoding: string
    • callback: Function

    Returns void

addListener

  • addListener(event: string, listener: Function): EventEmitter

emit

  • emit(event: string, ...args: any[]): boolean
  • Parameters

    • event: string
    • Rest ...args: any[]

    Returns boolean

end

  • end(): void
  • end(buffer: Buffer, cb?: Function): void
  • end(str: string, cb?: Function): void
  • end(str: string, encoding?: string, cb?: Function): void
  • Returns void

  • Parameters

    • buffer: Buffer
    • Optional cb: Function

    Returns void

  • Parameters

    • str: string
    • Optional cb: Function

    Returns void

  • Parameters

    • str: string
    • Optional encoding: string
    • Optional cb: Function

    Returns void

listeners

  • listeners(event: string): Function[]
  • Parameters

    • event: string

    Returns Function[]

on

  • Parameters

    • event: string
    • listener: Function

    Returns EventEmitter

once

  • Parameters

    • event: string
    • listener: Function

    Returns EventEmitter

pause

  • pause(): void
  • Returns void

pipe

  • pipe<T>(destination: T, options?: object): T
  • Type parameters

    Parameters

    • destination: T
    • Optional options: object
      • Optional end?: boolean

    Returns T

push

  • push(chunk: any, encoding?: string): boolean
  • Parameters

    • chunk: any
    • Optional encoding: string

    Returns boolean

read

  • read(size?: number): any
  • Parameters

    • Optional size: number

    Returns any

removeAllListeners

removeListener

  • removeListener(event: string, listener: Function): EventEmitter

resume

  • resume(): void
  • Returns void

setEncoding

  • setEncoding(encoding: string): void
  • Parameters

    • encoding: string

    Returns void

setMaxListeners

  • setMaxListeners(n: number): void

unpipe

  • unpipe<T>(destination?: T): void
  • Type parameters

    Parameters

    • Optional destination: T

    Returns void

unshift

  • unshift(chunk: string): void
  • unshift(chunk: Buffer): void
  • Parameters

    • chunk: string

    Returns void

  • Parameters

    Returns void

wrap

write

  • write(buffer: Buffer, cb?: Function): boolean
  • write(str: string, cb?: Function): boolean
  • write(str: string, encoding?: string, cb?: Function): boolean
  • Parameters

    • buffer: Buffer
    • Optional cb: Function

    Returns boolean

  • Parameters

    • str: string
    • Optional cb: Function

    Returns boolean

  • Parameters

    • str: string
    • Optional encoding: string
    • Optional cb: Function

    Returns boolean

listenerCount

  • listenerCount(emitter: EventEmitter, event: string): number

DeflateRaw

DeflateRaw:

constructor

readable

readable: boolean

writable

writable: boolean

_flush

  • _flush(callback: Function): void
  • Parameters

    • callback: Function

    Returns void

_transform

  • _transform(chunk: Buffer, encoding: string, callback: Function): void
  • _transform(chunk: string, encoding: string, callback: Function): void
  • Parameters

    • chunk: Buffer
    • encoding: string
    • callback: Function

    Returns void

  • Parameters

    • chunk: string
    • encoding: string
    • callback: Function

    Returns void

addListener

  • addListener(event: string, listener: Function): EventEmitter

emit

  • emit(event: string, ...args: any[]): boolean
  • Parameters

    • event: string
    • Rest ...args: any[]

    Returns boolean

end

  • end(): void
  • end(buffer: Buffer, cb?: Function): void
  • end(str: string, cb?: Function): void
  • end(str: string, encoding?: string, cb?: Function): void
  • Returns void

  • Parameters

    • buffer: Buffer
    • Optional cb: Function

    Returns void

  • Parameters

    • str: string
    • Optional cb: Function

    Returns void

  • Parameters

    • str: string
    • Optional encoding: string
    • Optional cb: Function

    Returns void

listeners

  • listeners(event: string): Function[]
  • Parameters

    • event: string

    Returns Function[]

on

  • Parameters

    • event: string
    • listener: Function

    Returns EventEmitter

once

  • Parameters

    • event: string
    • listener: Function

    Returns EventEmitter

pause

  • pause(): void
  • Returns void

pipe

  • pipe<T>(destination: T, options?: object): T
  • Type parameters

    Parameters

    • destination: T
    • Optional options: object
      • Optional end?: boolean

    Returns T

push

  • push(chunk: any, encoding?: string): boolean
  • Parameters

    • chunk: any
    • Optional encoding: string

    Returns boolean

read

  • read(size?: number): any
  • Parameters

    • Optional size: number

    Returns any

removeAllListeners

removeListener

  • removeListener(event: string, listener: Function): EventEmitter

resume

  • resume(): void
  • Returns void

setEncoding

  • setEncoding(encoding: string): void
  • Parameters

    • encoding: string

    Returns void

setMaxListeners

  • setMaxListeners(n: number): void

unpipe

  • unpipe<T>(destination?: T): void
  • Type parameters

    Parameters

    • Optional destination: T

    Returns void

unshift

  • unshift(chunk: string): void
  • unshift(chunk: Buffer): void
  • Parameters

    • chunk: string

    Returns void

  • Parameters

    Returns void

wrap

write

  • write(buffer: Buffer, cb?: Function): boolean
  • write(str: string, cb?: Function): boolean
  • write(str: string, encoding?: string, cb?: Function): boolean
  • Parameters

    • buffer: Buffer
    • Optional cb: Function

    Returns boolean

  • Parameters

    • str: string
    • Optional cb: Function

    Returns boolean

  • Parameters

    • str: string
    • Optional encoding: string
    • Optional cb: Function

    Returns boolean

listenerCount

  • listenerCount(emitter: EventEmitter, event: string): number

Gunzip

Gunzip:

constructor

readable

readable: boolean

writable

writable: boolean

_flush

  • _flush(callback: Function): void
  • Parameters

    • callback: Function

    Returns void

_transform

  • _transform(chunk: Buffer, encoding: string, callback: Function): void
  • _transform(chunk: string, encoding: string, callback: Function): void
  • Parameters

    • chunk: Buffer
    • encoding: string
    • callback: Function

    Returns void

  • Parameters

    • chunk: string
    • encoding: string
    • callback: Function

    Returns void

addListener

  • addListener(event: string, listener: Function): EventEmitter

emit

  • emit(event: string, ...args: any[]): boolean
  • Parameters

    • event: string
    • Rest ...args: any[]

    Returns boolean

end

  • end(): void
  • end(buffer: Buffer, cb?: Function): void
  • end(str: string, cb?: Function): void
  • end(str: string, encoding?: string, cb?: Function): void
  • Returns void

  • Parameters

    • buffer: Buffer
    • Optional cb: Function

    Returns void

  • Parameters

    • str: string
    • Optional cb: Function

    Returns void

  • Parameters

    • str: string
    • Optional encoding: string
    • Optional cb: Function

    Returns void

listeners

  • listeners(event: string): Function[]
  • Parameters

    • event: string

    Returns Function[]

on

  • Parameters

    • event: string
    • listener: Function

    Returns EventEmitter

once

  • Parameters

    • event: string
    • listener: Function

    Returns EventEmitter

pause

  • pause(): void
  • Returns void

pipe

  • pipe<T>(destination: T, options?: object): T
  • Type parameters

    Parameters

    • destination: T
    • Optional options: object
      • Optional end?: boolean

    Returns T

push

  • push(chunk: any, encoding?: string): boolean
  • Parameters

    • chunk: any
    • Optional encoding: string

    Returns boolean

read

  • read(size?: number): any
  • Parameters

    • Optional size: number

    Returns any

removeAllListeners

removeListener

  • removeListener(event: string, listener: Function): EventEmitter

resume

  • resume(): void
  • Returns void

setEncoding

  • setEncoding(encoding: string): void
  • Parameters

    • encoding: string

    Returns void

setMaxListeners

  • setMaxListeners(n: number): void

unpipe

  • unpipe<T>(destination?: T): void
  • Type parameters

    Parameters

    • Optional destination: T

    Returns void

unshift

  • unshift(chunk: string): void
  • unshift(chunk: Buffer): void
  • Parameters

    • chunk: string

    Returns void

  • Parameters

    Returns void

wrap

write

  • write(buffer: Buffer, cb?: Function): boolean
  • write(str: string, cb?: Function): boolean
  • write(str: string, encoding?: string, cb?: Function): boolean
  • Parameters

    • buffer: Buffer
    • Optional cb: Function

    Returns boolean

  • Parameters

    • str: string
    • Optional cb: Function

    Returns boolean

  • Parameters

    • str: string
    • Optional encoding: string
    • Optional cb: Function

    Returns boolean

listenerCount

  • listenerCount(emitter: EventEmitter, event: string): number

Gzip

Gzip:

constructor

readable

readable: boolean

writable

writable: boolean

_flush

  • _flush(callback: Function): void
  • Parameters

    • callback: Function

    Returns void

_transform

  • _transform(chunk: Buffer, encoding: string, callback: Function): void
  • _transform(chunk: string, encoding: string, callback: Function): void
  • Parameters

    • chunk: Buffer
    • encoding: string
    • callback: Function

    Returns void

  • Parameters

    • chunk: string
    • encoding: string
    • callback: Function

    Returns void

addListener

  • addListener(event: string, listener: Function): EventEmitter

emit

  • emit(event: string, ...args: any[]): boolean
  • Parameters

    • event: string
    • Rest ...args: any[]

    Returns boolean

end

  • end(): void
  • end(buffer: Buffer, cb?: Function): void
  • end(str: string, cb?: Function): void
  • end(str: string, encoding?: string, cb?: Function): void
  • Returns void

  • Parameters

    • buffer: Buffer
    • Optional cb: Function

    Returns void

  • Parameters

    • str: string
    • Optional cb: Function

    Returns void

  • Parameters

    • str: string
    • Optional encoding: string
    • Optional cb: Function

    Returns void

listeners

  • listeners(event: string): Function[]
  • Parameters

    • event: string

    Returns Function[]

on

  • Parameters

    • event: string
    • listener: Function

    Returns EventEmitter

once

  • Parameters

    • event: string
    • listener: Function

    Returns EventEmitter

pause

  • pause(): void
  • Returns void

pipe

  • pipe<T>(destination: T, options?: object): T
  • Type parameters

    Parameters

    • destination: T
    • Optional options: object
      • Optional end?: boolean

    Returns T

push

  • push(chunk: any, encoding?: string): boolean
  • Parameters

    • chunk: any
    • Optional encoding: string

    Returns boolean

read

  • read(size?: number): any
  • Parameters

    • Optional size: number

    Returns any

removeAllListeners

removeListener

  • removeListener(event: string, listener: Function): EventEmitter

resume

  • resume(): void
  • Returns void

setEncoding

  • setEncoding(encoding: string): void
  • Parameters

    • encoding: string

    Returns void

setMaxListeners

  • setMaxListeners(n: number): void

unpipe

  • unpipe<T>(destination?: T): void
  • Type parameters

    Parameters

    • Optional destination: T

    Returns void

unshift

  • unshift(chunk: string): void
  • unshift(chunk: Buffer): void
  • Parameters

    • chunk: string

    Returns void

  • Parameters

    Returns void

wrap

write

  • write(buffer: Buffer, cb?: Function): boolean
  • write(str: string, cb?: Function): boolean
  • write(str: string, encoding?: string, cb?: Function): boolean
  • Parameters

    • buffer: Buffer
    • Optional cb: Function

    Returns boolean

  • Parameters

    • str: string
    • Optional cb: Function

    Returns boolean

  • Parameters

    • str: string
    • Optional encoding: string
    • Optional cb: Function

    Returns boolean

listenerCount

  • listenerCount(emitter: EventEmitter, event: string): number

Inflate

Inflate:

constructor

readable

readable: boolean

writable

writable: boolean

_flush

  • _flush(callback: Function): void
  • Parameters

    • callback: Function

    Returns void

_transform

  • _transform(chunk: Buffer, encoding: string, callback: Function): void
  • _transform(chunk: string, encoding: string, callback: Function): void
  • Parameters

    • chunk: Buffer
    • encoding: string
    • callback: Function

    Returns void

  • Parameters

    • chunk: string
    • encoding: string
    • callback: Function

    Returns void

addListener

  • addListener(event: string, listener: Function): EventEmitter

emit

  • emit(event: string, ...args: any[]): boolean
  • Parameters

    • event: string
    • Rest ...args: any[]

    Returns boolean

end

  • end(): void
  • end(buffer: Buffer, cb?: Function): void
  • end(str: string, cb?: Function): void
  • end(str: string, encoding?: string, cb?: Function): void
  • Returns void

  • Parameters

    • buffer: Buffer
    • Optional cb: Function

    Returns void

  • Parameters

    • str: string
    • Optional cb: Function

    Returns void

  • Parameters

    • str: string
    • Optional encoding: string
    • Optional cb: Function

    Returns void

listeners

  • listeners(event: string): Function[]
  • Parameters

    • event: string

    Returns Function[]

on

  • Parameters

    • event: string
    • listener: Function

    Returns EventEmitter

once

  • Parameters

    • event: string
    • listener: Function

    Returns EventEmitter

pause

  • pause(): void
  • Returns void

pipe

  • pipe<T>(destination: T, options?: object): T
  • Type parameters

    Parameters

    • destination: T
    • Optional options: object
      • Optional end?: boolean

    Returns T

push

  • push(chunk: any, encoding?: string): boolean
  • Parameters

    • chunk: any
    • Optional encoding: string

    Returns boolean

read

  • read(size?: number): any
  • Parameters

    • Optional size: number

    Returns any

removeAllListeners

removeListener

  • removeListener(event: string, listener: Function): EventEmitter

resume

  • resume(): void
  • Returns void

setEncoding

  • setEncoding(encoding: string): void
  • Parameters

    • encoding: string

    Returns void

setMaxListeners

  • setMaxListeners(n: number): void

unpipe

  • unpipe<T>(destination?: T): void
  • Type parameters

    Parameters

    • Optional destination: T

    Returns void

unshift

  • unshift(chunk: string): void
  • unshift(chunk: Buffer): void
  • Parameters

    • chunk: string

    Returns void

  • Parameters

    Returns void

wrap

write

  • write(buffer: Buffer, cb?: Function): boolean
  • write(str: string, cb?: Function): boolean
  • write(str: string, encoding?: string, cb?: Function): boolean
  • Parameters

    • buffer: Buffer
    • Optional cb: Function

    Returns boolean

  • Parameters

    • str: string
    • Optional cb: Function

    Returns boolean

  • Parameters

    • str: string
    • Optional encoding: string
    • Optional cb: Function

    Returns boolean

listenerCount

  • listenerCount(emitter: EventEmitter, event: string): number

InflateRaw

InflateRaw:

constructor

readable

readable: boolean

writable

writable: boolean

_flush

  • _flush(callback: Function): void
  • Parameters

    • callback: Function

    Returns void

_transform

  • _transform(chunk: Buffer, encoding: string, callback: Function): void
  • _transform(chunk: string, encoding: string, callback: Function): void
  • Parameters

    • chunk: Buffer
    • encoding: string
    • callback: Function

    Returns void

  • Parameters

    • chunk: string
    • encoding: string
    • callback: Function

    Returns void

addListener

  • addListener(event: string, listener: Function): EventEmitter

emit

  • emit(event: string, ...args: any[]): boolean
  • Parameters

    • event: string
    • Rest ...args: any[]

    Returns boolean

end

  • end(): void
  • end(buffer: Buffer, cb?: Function): void
  • end(str: string, cb?: Function): void
  • end(str: string, encoding?: string, cb?: Function): void
  • Returns void

  • Parameters

    • buffer: Buffer
    • Optional cb: Function

    Returns void

  • Parameters

    • str: string
    • Optional cb: Function

    Returns void

  • Parameters

    • str: string
    • Optional encoding: string
    • Optional cb: Function

    Returns void

listeners

  • listeners(event: string): Function[]
  • Parameters

    • event: string

    Returns Function[]

on

  • Parameters

    • event: string
    • listener: Function

    Returns EventEmitter

once

  • Parameters

    • event: string
    • listener: Function

    Returns EventEmitter

pause

  • pause(): void
  • Returns void

pipe

  • pipe<T>(destination: T, options?: object): T
  • Type parameters

    Parameters

    • destination: T
    • Optional options: object
      • Optional end?: boolean

    Returns T

push

  • push(chunk: any, encoding?: string): boolean
  • Parameters

    • chunk: any
    • Optional encoding: string

    Returns boolean

read

  • read(size?: number): any
  • Parameters

    • Optional size: number

    Returns any

removeAllListeners

removeListener

  • removeListener(event: string, listener: Function): EventEmitter

resume

  • resume(): void
  • Returns void

setEncoding

  • setEncoding(encoding: string): void
  • Parameters

    • encoding: string

    Returns void

setMaxListeners

  • setMaxListeners(n: number): void

unpipe

  • unpipe<T>(destination?: T): void
  • Type parameters

    Parameters

    • Optional destination: T

    Returns void

unshift

  • unshift(chunk: string): void
  • unshift(chunk: Buffer): void
  • Parameters

    • chunk: string

    Returns void

  • Parameters

    Returns void

wrap

write

  • write(buffer: Buffer, cb?: Function): boolean
  • write(str: string, cb?: Function): boolean
  • write(str: string, encoding?: string, cb?: Function): boolean
  • Parameters

    • buffer: Buffer
    • Optional cb: Function

    Returns boolean

  • Parameters

    • str: string
    • Optional cb: Function

    Returns boolean

  • Parameters

    • str: string
    • Optional encoding: string
    • Optional cb: Function

    Returns boolean

listenerCount

  • listenerCount(emitter: EventEmitter, event: string): number

Unzip

Unzip:

constructor

readable

readable: boolean

writable

writable: boolean

_flush

  • _flush(callback: Function): void
  • Parameters

    • callback: Function

    Returns void

_transform

  • _transform(chunk: Buffer, encoding: string, callback: Function): void
  • _transform(chunk: string, encoding: string, callback: Function): void
  • Parameters

    • chunk: Buffer
    • encoding: string
    • callback: Function

    Returns void

  • Parameters

    • chunk: string
    • encoding: string
    • callback: Function

    Returns void

addListener

  • addListener(event: string, listener: Function): EventEmitter

emit

  • emit(event: string, ...args: any[]): boolean
  • Parameters

    • event: string
    • Rest ...args: any[]

    Returns boolean

end

  • end(): void
  • end(buffer: Buffer, cb?: Function): void
  • end(str: string, cb?: Function): void
  • end(str: string, encoding?: string, cb?: Function): void
  • Returns void

  • Parameters

    • buffer: Buffer
    • Optional cb: Function

    Returns void

  • Parameters

    • str: string
    • Optional cb: Function

    Returns void

  • Parameters

    • str: string
    • Optional encoding: string
    • Optional cb: Function

    Returns void

listeners

  • listeners(event: string): Function[]
  • Parameters

    • event: string

    Returns Function[]

on

  • Parameters

    • event: string
    • listener: Function

    Returns EventEmitter

once

  • Parameters

    • event: string
    • listener: Function

    Returns EventEmitter

pause

  • pause(): void
  • Returns void

pipe

  • pipe<T>(destination: T, options?: object): T
  • Type parameters

    Parameters

    • destination: T
    • Optional options: object
      • Optional end?: boolean

    Returns T

push

  • push(chunk: any, encoding?: string): boolean
  • Parameters

    • chunk: any
    • Optional encoding: string

    Returns boolean

read

  • read(size?: number): any
  • Parameters

    • Optional size: number

    Returns any

removeAllListeners

removeListener

  • removeListener(event: string, listener: Function): EventEmitter

resume

  • resume(): void
  • Returns void

setEncoding

  • setEncoding(encoding: string): void
  • Parameters

    • encoding: string

    Returns void

setMaxListeners

  • setMaxListeners(n: number): void

unpipe

  • unpipe<T>(destination?: T): void
  • Type parameters

    Parameters

    • Optional destination: T

    Returns void

unshift

  • unshift(chunk: string): void
  • unshift(chunk: Buffer): void
  • Parameters

    • chunk: string

    Returns void

  • Parameters

    Returns void

wrap

write

  • write(buffer: Buffer, cb?: Function): boolean
  • write(str: string, cb?: Function): boolean
  • write(str: string, encoding?: string, cb?: Function): boolean
  • Parameters

    • buffer: Buffer
    • Optional cb: Function

    Returns boolean

  • Parameters

    • str: string
    • Optional cb: Function

    Returns boolean

  • Parameters

    • str: string
    • Optional encoding: string
    • Optional cb: Function

    Returns boolean

listenerCount

  • listenerCount(emitter: EventEmitter, event: string): number

ZlibOptions

ZlibOptions:

chunkSize

chunkSize: number

dictionary

dictionary: any

level

level: number

memLevel

memLevel: number

strategy

strategy: number

windowBits

windowBits: number

Z_ASCII

Z_ASCII: number

Z_BEST_COMPRESSION

Z_BEST_COMPRESSION: number

Z_BEST_SPEED

Z_BEST_SPEED: number

Z_BINARY

Z_BINARY: number

Z_BLOCK

Z_BLOCK: number

Z_BUF_ERROR

Z_BUF_ERROR: number

Z_DATA_ERROR

Z_DATA_ERROR: number

Z_DEFAULT_COMPRESSION

Z_DEFAULT_COMPRESSION: number

Z_DEFAULT_STRATEGY

Z_DEFAULT_STRATEGY: number

Z_DEFLATED

Z_DEFLATED: number

Z_ERRNO

Z_ERRNO: number

Z_FILTERED

Z_FILTERED: number

Z_FINISH

Z_FINISH: number

Z_FIXED

Z_FIXED: number

Z_FULL_FLUSH

Z_FULL_FLUSH: number

Z_HUFFMAN_ONLY

Z_HUFFMAN_ONLY: number

Z_MEM_ERROR

Z_MEM_ERROR: number

Z_NEED_DICT

Z_NEED_DICT: number

Z_NO_COMPRESSION

Z_NO_COMPRESSION: number

Z_NO_FLUSH

Z_NO_FLUSH: number

Z_NULL

Z_NULL: number

Z_OK

Z_OK: number

Z_PARTIAL_FLUSH

Z_PARTIAL_FLUSH: number

Z_RLE

Z_RLE: number

Z_STREAM_END

Z_STREAM_END: number

Z_STREAM_ERROR

Z_STREAM_ERROR: number

Z_SYNC_FLUSH

Z_SYNC_FLUSH: number

Z_TEXT

Z_TEXT: number

Z_TREES

Z_TREES: number

Z_UNKNOWN

Z_UNKNOWN: number

Z_VERSION_ERROR

Z_VERSION_ERROR: number

createDeflate

  • Parameters

    Returns Deflate

createDeflateRaw

  • Parameters

    Returns DeflateRaw

createGunzip

  • Parameters

    Returns Gunzip

createGzip

  • Parameters

    Returns Gzip

createInflate

  • Parameters

    Returns Inflate

createInflateRaw

  • Parameters

    Returns InflateRaw

createUnzip

  • Parameters

    Returns Unzip

deflate

  • deflate(buf: Buffer, callback: function): void
  • Parameters

    • buf: Buffer
    • callback: function
        • (error: Error, result: any): void
        • Parameters

          • error: Error
          • result: any

          Returns void

    Returns void

deflateRaw

  • deflateRaw(buf: Buffer, callback: function): void
  • Parameters

    • buf: Buffer
    • callback: function
        • (error: Error, result: any): void
        • Parameters

          • error: Error
          • result: any

          Returns void

    Returns void

deflateRawSync

  • Parameters

    Returns any

deflateSync

  • Parameters

    Returns any

gunzip

  • gunzip(buf: Buffer, callback: function): void
  • Parameters

    • buf: Buffer
    • callback: function
        • (error: Error, result: any): void
        • Parameters

          • error: Error
          • result: any

          Returns void

    Returns void

gunzipSync

  • Parameters

    Returns any

gzip

  • gzip(buf: Buffer, callback: function): void
  • Parameters

    • buf: Buffer
    • callback: function
        • (error: Error, result: any): void
        • Parameters

          • error: Error
          • result: any

          Returns void

    Returns void

gzipSync

  • Parameters

    Returns any

inflate

  • inflate(buf: Buffer, callback: function): void
  • Parameters

    • buf: Buffer
    • callback: function
        • (error: Error, result: any): void
        • Parameters

          • error: Error
          • result: any

          Returns void

    Returns void

inflateRaw

  • inflateRaw(buf: Buffer, callback: function): void
  • Parameters

    • buf: Buffer
    • callback: function
        • (error: Error, result: any): void
        • Parameters

          • error: Error
          • result: any

          Returns void

    Returns void

inflateRawSync

  • Parameters

    Returns any

inflateSync

  • Parameters

    Returns any

unzip

  • unzip(buf: Buffer, callback: function): void
  • Parameters

    • buf: Buffer
    • callback: function
        • (error: Error, result: any): void
        • Parameters

          • error: Error
          • result: any

          Returns void

    Returns void

unzipSync

  • Parameters

    Returns any

NodeJS

NodeJS:
                                          *
          GLOBAL INTERFACES               *
                                          *

ErrnoException

ErrnoException:

Error

Error: ErrorConstructor

code

code: string

errno

errno: number

message

message: string

name

name: string

path

path: string

stack

stack: string

syscall

syscall: string

EventEmitter

EventEmitter:

addListener

  • addListener(event: string, listener: Function): EventEmitter
  • Parameters

    • event: string
    • listener: Function

    Returns EventEmitter

emit

  • emit(event: string, ...args: any[]): boolean
  • Parameters

    • event: string
    • Rest ...args: any[]

    Returns boolean

listeners

  • listeners(event: string): Function[]
  • Parameters

    • event: string

    Returns Function[]

on

  • Parameters

    • event: string
    • listener: Function

    Returns EventEmitter

once

  • Parameters

    • event: string
    • listener: Function

    Returns EventEmitter

removeAllListeners

  • Parameters

    • Optional event: string

    Returns EventEmitter

removeListener

  • removeListener(event: string, listener: Function): EventEmitter
  • Parameters

    • event: string
    • listener: Function

    Returns EventEmitter

setMaxListeners

  • setMaxListeners(n: number): void
  • Parameters

    • n: number

    Returns void

Global

Global:

Array

Array: ArrayConstructor

ArrayBuffer

ArrayBuffer: ArrayBufferConstructor

Boolean

Boolean: BooleanConstructor

Buffer

Buffer: object

Type declaration

  • constructor: function
    • new __type(str: string, encoding?: string): __type
    • new __type(size: number): __type
    • new __type(array: Uint8Array): __type
    • new __type(array: any[]): __type
    • Allocates a new buffer containing the given {str}.

      Parameters

      • str: string

        String to store in buffer.

      • Optional encoding: string

        encoding to use, optional. Default is 'utf8'

      Returns __type

    • Allocates a new buffer of {size} octets.

      Parameters

      • size: number

        count of octets to allocate.

      Returns __type

    • Allocates a new buffer containing the given {array} of octets.

      Parameters

      • array: Uint8Array

        The octets to store.

      Returns __type

    • Allocates a new buffer containing the given {array} of octets.

      Parameters

      • array: any[]

        The octets to store.

      Returns __type

  • prototype: Buffer
  • byteLength: function
    • byteLength(string: string, encoding?: string): number
    • Gives the actual byte length of a string. encoding defaults to 'utf8'. This is not the same as String.prototype.length since that returns the number of characters in a string.

      Parameters

      • string: string

        string to test.

      • Optional encoding: string

        encoding used to evaluate (defaults to 'utf8')

      Returns number

  • compare: function
    • The same as buf1.compare(buf2).

      Parameters

      Returns number

  • concat: function
    • Returns a buffer which is the result of concatenating all the buffers in the list together.

      If the list has no items, or if the totalLength is 0, then it returns a zero-length buffer. If the list has exactly one item, then the first item of the list is returned. If the list has more than one item, then a new Buffer is created.

      Parameters

      • list: Buffer[]

        An array of Buffer objects to concatenate

      • Optional totalLength: number

        Total length of the buffers when concatenated. If totalLength is not provided, it is read from the buffers in the list. However, this adds an additional loop to the function, so it is faster to provide the length explicitly.

      Returns Buffer

  • isBuffer: function
    • isBuffer(obj: any): boolean
    • Returns true if {obj} is a Buffer

      Parameters

      • obj: any

        object to test.

      Returns boolean

  • isEncoding: function
    • isEncoding(encoding: string): boolean
    • Returns true if {encoding} is a valid encoding argument. Valid string encodings in Node 0.12: 'ascii'|'utf8'|'utf16le'|'ucs2'(alias of 'utf16le')|'base64'|'binary'(deprecated)|'hex'

      Parameters

      • encoding: string

        string to test.

      Returns boolean

DataView

DataView: DataViewConstructor

Date

Date: DateConstructor

Error

Error: ErrorConstructor

EvalError

EvalError: EvalErrorConstructor

Float32Array

Float32Array: Float32ArrayConstructor

Float64Array

Float64Array: Float64ArrayConstructor

Function

Function: FunctionConstructor

GLOBAL

GLOBAL: Global

Infinity

Infinity: number

Int16Array

Int16Array: Int16ArrayConstructor

Int32Array

Int32Array: Int32ArrayConstructor

Int8Array

Int8Array: Int8ArrayConstructor

Intl

Intl: Intl

JSON

JSON: JSON

Map

Math

Math: Math

NaN

NaN: number

Number

Number: NumberConstructor

Object

Object: ObjectConstructor

Promise

Promise: Function

RangeError

RangeError: RangeErrorConstructor

ReferenceError

ReferenceError: ReferenceErrorConstructor

RegExp

RegExp: RegExpConstructor

Set

String

String: StringConstructor

Symbol

Symbol: Function

SyntaxError

SyntaxError: SyntaxErrorConstructor

TypeError

TypeError: TypeErrorConstructor

URIError

URIError: URIErrorConstructor

Uint16Array

Uint16Array: Uint16ArrayConstructor

Uint32Array

Uint32Array: Uint32ArrayConstructor

Uint8Array

Uint8Array: Uint8ArrayConstructor

Uint8ClampedArray

Uint8ClampedArray: Function

WeakMap

WeakSet

clearImmediate

clearImmediate: function

Type declaration

    • (immediateId: any): void
    • Parameters

      • immediateId: any

      Returns void

clearInterval

clearInterval: function

Type declaration

    • (intervalId: Timer): void
    • Parameters

      Returns void

clearTimeout

clearTimeout: function

Type declaration

    • (timeoutId: Timer): void
    • Parameters

      Returns void

console

console: Console

decodeURI

decodeURI: decodeURI

decodeURIComponent

decodeURIComponent: decodeURIComponent

encodeURI

encodeURI: encodeURI

encodeURIComponent

encodeURIComponent: encodeURIComponent

escape

escape: function

Type declaration

    • (str: string): string
    • Parameters

      • str: string

      Returns string

eval

eval: eval

gc

gc: function

Type declaration

    • (): void
    • Returns void

global

global: Global

isFinite

isFinite: isFinite

isNaN

isNaN: isNaN

parseFloat

parseFloat: parseFloat

parseInt

parseInt: parseInt

process

process: Process

root

root: Global

setImmediate

setImmediate: function

Type declaration

    • (callback: function, ...args: any[]): any
    • Parameters

      • callback: function
          • (...args: any[]): void
          • Parameters

            • Rest ...args: any[]

            Returns void

      • Rest ...args: any[]

      Returns any

setInterval

setInterval: function

Type declaration

    • (callback: function, ms: number, ...args: any[]): Timer
    • Parameters

      • callback: function
          • (...args: any[]): void
          • Parameters

            • Rest ...args: any[]

            Returns void

      • ms: number
      • Rest ...args: any[]

      Returns Timer

setTimeout

setTimeout: function

Type declaration

    • (callback: function, ms: number, ...args: any[]): Timer
    • Parameters

      • callback: function
          • (...args: any[]): void
          • Parameters

            • Rest ...args: any[]

            Returns void

      • ms: number
      • Rest ...args: any[]

      Returns Timer

undefined

undefined: any

unescape

unescape: function

Type declaration

    • (str: string): string
    • Parameters

      • str: string

      Returns string

Process

Process:

arch

arch: string

argv

argv: string[]

config

config: object

Type declaration

  • target_defaults: object
    • cflags: any[]
    • default_configuration: string
    • defines: string[]
    • include_dirs: string[]
    • libraries: string[]
  • variables: object
    • clang: number
    • host_arch: string
    • node_install_npm: boolean
    • node_install_waf: boolean
    • node_prefix: string
    • node_shared_openssl: boolean
    • node_shared_v8: boolean
    • node_shared_zlib: boolean
    • node_use_dtrace: boolean
    • node_use_etw: boolean
    • node_use_openssl: boolean
    • target_arch: string
    • v8_no_strict_aliasing: number
    • v8_use_snapshot: boolean
    • visibility: string

env

env: any

execPath

execPath: string

pid

pid: number

platform

platform: string

stderr

stdin

stdout

title

title: string

version

version: string

versions

versions: object

Type declaration

  • ares: string
  • http_parser: string
  • node: string
  • openssl: string
  • uv: string
  • v8: string
  • zlib: string

abort

  • abort(): void
  • Returns void

addListener

  • addListener(event: string, listener: Function): EventEmitter

chdir

  • chdir(directory: string): void
  • Parameters

    • directory: string

    Returns void

cwd

  • cwd(): string
  • Returns string

emit

  • emit(event: string, ...args: any[]): boolean
  • Parameters

    • event: string
    • Rest ...args: any[]

    Returns boolean

exit

  • exit(code?: number): void
  • Parameters

    • Optional code: number

    Returns void

getgid

  • getgid(): number
  • Returns number

getuid

  • getuid(): number
  • Returns number

hrtime

  • hrtime(time?: number[]): number[]
  • Parameters

    • Optional time: number[]

    Returns number[]

kill

  • kill(pid: number, signal?: string): void
  • Parameters

    • pid: number
    • Optional signal: string

    Returns void

listeners

  • listeners(event: string): Function[]
  • Parameters

    • event: string

    Returns Function[]

memoryUsage

  • memoryUsage(): object
  • Returns object

    • heapTotal: number
    • heapUsed: number
    • rss: number

nextTick

  • nextTick(callback: Function): void
  • Parameters

    • callback: Function

    Returns void

on

  • Parameters

    • event: string
    • listener: Function

    Returns EventEmitter

once

  • Parameters

    • event: string
    • listener: Function

    Returns EventEmitter

removeAllListeners

removeListener

  • removeListener(event: string, listener: Function): EventEmitter

send

  • send(message: any, sendHandle?: any): void
  • Parameters

    • message: any
    • Optional sendHandle: any

    Returns void

setMaxListeners

  • setMaxListeners(n: number): void

setgid

  • setgid(id: number): void
  • setgid(id: string): void
  • Parameters

    • id: number

    Returns void

  • Parameters

    • id: string

    Returns void

setuid

  • setuid(id: number): void
  • setuid(id: string): void
  • Parameters

    • id: number

    Returns void

  • Parameters

    • id: string

    Returns void

umask

  • umask(mask?: number): number
  • Parameters

    • Optional mask: number

    Returns number

uptime

  • uptime(): number
  • Returns number

ReadWriteStream

ReadWriteStream:

readable

readable: boolean

writable

writable: boolean

addListener

  • addListener(event: string, listener: Function): EventEmitter

emit

  • emit(event: string, ...args: any[]): boolean
  • Parameters

    • event: string
    • Rest ...args: any[]

    Returns boolean

end

  • end(): void
  • end(buffer: Buffer, cb?: Function): void
  • end(str: string, cb?: Function): void
  • end(str: string, encoding?: string, cb?: Function): void
  • Returns void

  • Parameters

    • buffer: Buffer
    • Optional cb: Function

    Returns void

  • Parameters

    • str: string
    • Optional cb: Function

    Returns void

  • Parameters

    • str: string
    • Optional encoding: string
    • Optional cb: Function

    Returns void

listeners

  • listeners(event: string): Function[]

on

once

pause

  • pause(): void
  • Returns void

pipe

  • pipe<T>(destination: T, options?: object): T
  • Type parameters

    Parameters

    • destination: T
    • Optional options: object
      • Optional end?: boolean

    Returns T

read

  • read(size?: number): string | Buffer
  • Parameters

    • Optional size: number

    Returns string | Buffer

removeAllListeners

removeListener

  • removeListener(event: string, listener: Function): EventEmitter

resume

  • resume(): void
  • Returns void

setEncoding

  • setEncoding(encoding: string): void
  • Parameters

    • encoding: string

    Returns void

setMaxListeners

  • setMaxListeners(n: number): void

unpipe

  • unpipe<T>(destination?: T): void
  • Type parameters

    Parameters

    • Optional destination: T

    Returns void

unshift

  • unshift(chunk: string): void
  • unshift(chunk: Buffer): void
  • Parameters

    • chunk: string

    Returns void

  • Parameters

    Returns void

wrap

write

  • write(buffer: Buffer, cb?: Function): boolean
  • write(str: string, cb?: Function): boolean
  • write(str: string, encoding?: string, cb?: Function): boolean
  • Parameters

    • buffer: Buffer
    • Optional cb: Function

    Returns boolean

  • Parameters

    • str: string
    • Optional cb: Function

    Returns boolean

  • Parameters

    • str: string
    • Optional encoding: string
    • Optional cb: Function

    Returns boolean

ReadableStream

ReadableStream:

readable

readable: boolean

addListener

  • addListener(event: string, listener: Function): EventEmitter

emit

  • emit(event: string, ...args: any[]): boolean
  • Parameters

    • event: string
    • Rest ...args: any[]

    Returns boolean

listeners

  • listeners(event: string): Function[]
  • Parameters

    • event: string

    Returns Function[]

on

  • Parameters

    • event: string
    • listener: Function

    Returns EventEmitter

once

  • Parameters

    • event: string
    • listener: Function

    Returns EventEmitter

pause

  • pause(): void
  • Returns void

pipe

  • pipe<T>(destination: T, options?: object): T
  • Type parameters

    Parameters

    • destination: T
    • Optional options: object
      • Optional end?: boolean

    Returns T

read

  • read(size?: number): string | Buffer
  • Parameters

    • Optional size: number

    Returns string | Buffer

removeAllListeners

removeListener

  • removeListener(event: string, listener: Function): EventEmitter

resume

  • resume(): void
  • Returns void

setEncoding

  • setEncoding(encoding: string): void
  • Parameters

    • encoding: string

    Returns void

setMaxListeners

  • setMaxListeners(n: number): void

unpipe

  • unpipe<T>(destination?: T): void
  • Type parameters

    Parameters

    • Optional destination: T

    Returns void

unshift

  • unshift(chunk: string): void
  • unshift(chunk: Buffer): void
  • Parameters

    • chunk: string

    Returns void

  • Parameters

    Returns void

wrap

Timer

Timer:

ref

  • ref(): void
  • Returns void

unref

  • unref(): void
  • Returns void

WritableStream

WritableStream:

writable

writable: boolean

addListener

  • addListener(event: string, listener: Function): EventEmitter

emit

  • emit(event: string, ...args: any[]): boolean
  • Parameters

    • event: string
    • Rest ...args: any[]

    Returns boolean

end

  • end(): void
  • end(buffer: Buffer, cb?: Function): void
  • end(str: string, cb?: Function): void
  • end(str: string, encoding?: string, cb?: Function): void
  • Returns void

  • Parameters

    • buffer: Buffer
    • Optional cb: Function

    Returns void

  • Parameters

    • str: string
    • Optional cb: Function

    Returns void

  • Parameters

    • str: string
    • Optional encoding: string
    • Optional cb: Function

    Returns void

listeners

  • listeners(event: string): Function[]
  • Parameters

    • event: string

    Returns Function[]

on

  • Parameters

    • event: string
    • listener: Function

    Returns EventEmitter

once

  • Parameters

    • event: string
    • listener: Function

    Returns EventEmitter

removeAllListeners

removeListener

  • removeListener(event: string, listener: Function): EventEmitter

setMaxListeners

  • setMaxListeners(n: number): void

write

  • write(buffer: Buffer, cb?: Function): boolean
  • write(str: string, cb?: Function): boolean
  • write(str: string, encoding?: string, cb?: Function): boolean
  • Parameters

    • buffer: Buffer
    • Optional cb: Function

    Returns boolean

  • Parameters

    • str: string
    • Optional cb: Function

    Returns boolean

  • Parameters

    • str: string
    • Optional encoding: string
    • Optional cb: Function

    Returns boolean

Buffer

Buffer:

Raw data is stored in instances of the Buffer class. A Buffer is similar to an array of integers but corresponds to a raw memory allocation outside the V8 heap. A Buffer cannot be resized. Valid string encodings: 'ascii'|'utf8'|'utf16le'|'ucs2'(alias of 'utf16le')|'base64'|'binary'(deprecated)|'hex'

length

length: number

compare

  • compare(otherBuffer: Buffer): number
  • Parameters

    Returns number

copy

  • copy(targetBuffer: Buffer, targetStart?: number, sourceStart?: number, sourceEnd?: number): number
  • Parameters

    • targetBuffer: Buffer
    • Optional targetStart: number
    • Optional sourceStart: number
    • Optional sourceEnd: number

    Returns number

equals

  • equals(otherBuffer: Buffer): boolean
  • Parameters

    Returns boolean

fill

  • fill(value: any, offset?: number, end?: number): void
  • Parameters

    • value: any
    • Optional offset: number
    • Optional end: number

    Returns void

readDoubleBE

  • readDoubleBE(offset: number, noAssert?: boolean): number
  • Parameters

    • offset: number
    • Optional noAssert: boolean

    Returns number

readDoubleLE

  • readDoubleLE(offset: number, noAssert?: boolean): number
  • Parameters

    • offset: number
    • Optional noAssert: boolean

    Returns number

readFloatBE

  • readFloatBE(offset: number, noAssert?: boolean): number
  • Parameters

    • offset: number
    • Optional noAssert: boolean

    Returns number

readFloatLE

  • readFloatLE(offset: number, noAssert?: boolean): number
  • Parameters

    • offset: number
    • Optional noAssert: boolean

    Returns number

readInt16BE

  • readInt16BE(offset: number, noAssert?: boolean): number
  • Parameters

    • offset: number
    • Optional noAssert: boolean

    Returns number

readInt16LE

  • readInt16LE(offset: number, noAssert?: boolean): number
  • Parameters

    • offset: number
    • Optional noAssert: boolean

    Returns number

readInt32BE

  • readInt32BE(offset: number, noAssert?: boolean): number
  • Parameters

    • offset: number
    • Optional noAssert: boolean

    Returns number

readInt32LE

  • readInt32LE(offset: number, noAssert?: boolean): number
  • Parameters

    • offset: number
    • Optional noAssert: boolean

    Returns number

readInt8

  • readInt8(offset: number, noAssert?: boolean): number
  • Parameters

    • offset: number
    • Optional noAssert: boolean

    Returns number

readIntBE

  • readIntBE(offset: number, byteLength: number, noAssert?: boolean): number
  • Parameters

    • offset: number
    • byteLength: number
    • Optional noAssert: boolean

    Returns number

readIntLE

  • readIntLE(offset: number, byteLength: number, noAssert?: boolean): number
  • Parameters

    • offset: number
    • byteLength: number
    • Optional noAssert: boolean

    Returns number

readUInt16BE

  • readUInt16BE(offset: number, noAssert?: boolean): number
  • Parameters

    • offset: number
    • Optional noAssert: boolean

    Returns number

readUInt16LE

  • readUInt16LE(offset: number, noAssert?: boolean): number
  • Parameters

    • offset: number
    • Optional noAssert: boolean

    Returns number

readUInt32BE

  • readUInt32BE(offset: number, noAssert?: boolean): number
  • Parameters

    • offset: number
    • Optional noAssert: boolean

    Returns number

readUInt32LE

  • readUInt32LE(offset: number, noAssert?: boolean): number
  • Parameters

    • offset: number
    • Optional noAssert: boolean

    Returns number

readUInt8

  • readUInt8(offset: number, noAsset?: boolean): number
  • Parameters

    • offset: number
    • Optional noAsset: boolean

    Returns number

readUIntBE

  • readUIntBE(offset: number, byteLength: number, noAssert?: boolean): number
  • Parameters

    • offset: number
    • byteLength: number
    • Optional noAssert: boolean

    Returns number

readUIntLE

  • readUIntLE(offset: number, byteLength: number, noAssert?: boolean): number
  • Parameters

    • offset: number
    • byteLength: number
    • Optional noAssert: boolean

    Returns number

slice

  • slice(start?: number, end?: number): Buffer
  • Parameters

    • Optional start: number
    • Optional end: number

    Returns Buffer

toJSON

  • toJSON(): any
  • Returns any

toString

  • toString(encoding?: string, start?: number, end?: number): string
  • Parameters

    • Optional encoding: string
    • Optional start: number
    • Optional end: number

    Returns string

write

  • write(string: string, offset?: number, length?: number, encoding?: string): number
  • Parameters

    • string: string
    • Optional offset: number
    • Optional length: number
    • Optional encoding: string

    Returns number

writeDoubleBE

  • writeDoubleBE(value: number, offset: number, noAssert?: boolean): void
  • Parameters

    • value: number
    • offset: number
    • Optional noAssert: boolean

    Returns void

writeDoubleLE

  • writeDoubleLE(value: number, offset: number, noAssert?: boolean): void
  • Parameters

    • value: number
    • offset: number
    • Optional noAssert: boolean

    Returns void

writeFloatBE

  • writeFloatBE(value: number, offset: number, noAssert?: boolean): void
  • Parameters

    • value: number
    • offset: number
    • Optional noAssert: boolean

    Returns void

writeFloatLE

  • writeFloatLE(value: number, offset: number, noAssert?: boolean): void
  • Parameters

    • value: number
    • offset: number
    • Optional noAssert: boolean

    Returns void

writeInt16BE

  • writeInt16BE(value: number, offset: number, noAssert?: boolean): void
  • Parameters

    • value: number
    • offset: number
    • Optional noAssert: boolean

    Returns void

writeInt16LE

  • writeInt16LE(value: number, offset: number, noAssert?: boolean): void
  • Parameters

    • value: number
    • offset: number
    • Optional noAssert: boolean

    Returns void

writeInt32BE

  • writeInt32BE(value: number, offset: number, noAssert?: boolean): void
  • Parameters

    • value: number
    • offset: number
    • Optional noAssert: boolean

    Returns void

writeInt32LE

  • writeInt32LE(value: number, offset: number, noAssert?: boolean): void
  • Parameters

    • value: number
    • offset: number
    • Optional noAssert: boolean

    Returns void

writeInt8

  • writeInt8(value: number, offset: number, noAssert?: boolean): void
  • Parameters

    • value: number
    • offset: number
    • Optional noAssert: boolean

    Returns void

writeIntBE

  • writeIntBE(value: number, offset: number, byteLength: number, noAssert?: boolean): number
  • Parameters

    • value: number
    • offset: number
    • byteLength: number
    • Optional noAssert: boolean

    Returns number

writeIntLE

  • writeIntLE(value: number, offset: number, byteLength: number, noAssert?: boolean): number
  • Parameters

    • value: number
    • offset: number
    • byteLength: number
    • Optional noAssert: boolean

    Returns number

writeUInt16BE

  • writeUInt16BE(value: number, offset: number, noAssert?: boolean): void
  • Parameters

    • value: number
    • offset: number
    • Optional noAssert: boolean

    Returns void

writeUInt16LE

  • writeUInt16LE(value: number, offset: number, noAssert?: boolean): void
  • Parameters

    • value: number
    • offset: number
    • Optional noAssert: boolean

    Returns void

writeUInt32BE

  • writeUInt32BE(value: number, offset: number, noAssert?: boolean): void
  • Parameters

    • value: number
    • offset: number
    • Optional noAssert: boolean

    Returns void

writeUInt32LE

  • writeUInt32LE(value: number, offset: number, noAssert?: boolean): void
  • Parameters

    • value: number
    • offset: number
    • Optional noAssert: boolean

    Returns void

writeUInt8

  • writeUInt8(value: number, offset: number, noAssert?: boolean): void
  • Parameters

    • value: number
    • offset: number
    • Optional noAssert: boolean

    Returns void

writeUIntBE

  • writeUIntBE(value: number, offset: number, byteLength: number, noAssert?: boolean): number
  • Parameters

    • value: number
    • offset: number
    • byteLength: number
    • Optional noAssert: boolean

    Returns number

writeUIntLE

  • writeUIntLE(value: number, offset: number, byteLength: number, noAssert?: boolean): number
  • Parameters

    • value: number
    • offset: number
    • byteLength: number
    • Optional noAssert: boolean

    Returns number

MapConstructor

MapConstructor:
                                          *
          Node.js v0.12.0 API             *
                                          *

NodeBuffer

NodeBuffer:
deprecated

length

length: number

compare

  • compare(otherBuffer: Buffer): number
  • Parameters

    Returns number

copy

  • copy(targetBuffer: Buffer, targetStart?: number, sourceStart?: number, sourceEnd?: number): number
  • Parameters

    • targetBuffer: Buffer
    • Optional targetStart: number
    • Optional sourceStart: number
    • Optional sourceEnd: number

    Returns number

equals

  • equals(otherBuffer: Buffer): boolean
  • Parameters

    Returns boolean

fill

  • fill(value: any, offset?: number, end?: number): void
  • Parameters

    • value: any
    • Optional offset: number
    • Optional end: number

    Returns void

readDoubleBE

  • readDoubleBE(offset: number, noAssert?: boolean): number
  • Parameters

    • offset: number
    • Optional noAssert: boolean

    Returns number

readDoubleLE

  • readDoubleLE(offset: number, noAssert?: boolean): number
  • Parameters

    • offset: number
    • Optional noAssert: boolean

    Returns number

readFloatBE

  • readFloatBE(offset: number, noAssert?: boolean): number
  • Parameters

    • offset: number
    • Optional noAssert: boolean

    Returns number

readFloatLE

  • readFloatLE(offset: number, noAssert?: boolean): number
  • Parameters

    • offset: number
    • Optional noAssert: boolean

    Returns number

readInt16BE

  • readInt16BE(offset: number, noAssert?: boolean): number
  • Parameters

    • offset: number
    • Optional noAssert: boolean

    Returns number

readInt16LE

  • readInt16LE(offset: number, noAssert?: boolean): number
  • Parameters

    • offset: number
    • Optional noAssert: boolean

    Returns number

readInt32BE

  • readInt32BE(offset: number, noAssert?: boolean): number
  • Parameters

    • offset: number
    • Optional noAssert: boolean

    Returns number

readInt32LE

  • readInt32LE(offset: number, noAssert?: boolean): number
  • Parameters

    • offset: number
    • Optional noAssert: boolean

    Returns number

readInt8

  • readInt8(offset: number, noAssert?: boolean): number
  • Parameters

    • offset: number
    • Optional noAssert: boolean

    Returns number

readIntBE

  • readIntBE(offset: number, byteLength: number, noAssert?: boolean): number
  • Parameters

    • offset: number
    • byteLength: number
    • Optional noAssert: boolean

    Returns number

readIntLE

  • readIntLE(offset: number, byteLength: number, noAssert?: boolean): number
  • Parameters

    • offset: number
    • byteLength: number
    • Optional noAssert: boolean

    Returns number

readUInt16BE

  • readUInt16BE(offset: number, noAssert?: boolean): number
  • Parameters

    • offset: number
    • Optional noAssert: boolean

    Returns number

readUInt16LE

  • readUInt16LE(offset: number, noAssert?: boolean): number
  • Parameters

    • offset: number
    • Optional noAssert: boolean

    Returns number

readUInt32BE

  • readUInt32BE(offset: number, noAssert?: boolean): number
  • Parameters

    • offset: number
    • Optional noAssert: boolean

    Returns number

readUInt32LE

  • readUInt32LE(offset: number, noAssert?: boolean): number
  • Parameters

    • offset: number
    • Optional noAssert: boolean

    Returns number

readUInt8

  • readUInt8(offset: number, noAsset?: boolean): number
  • Parameters

    • offset: number
    • Optional noAsset: boolean

    Returns number

readUIntBE

  • readUIntBE(offset: number, byteLength: number, noAssert?: boolean): number
  • Parameters

    • offset: number
    • byteLength: number
    • Optional noAssert: boolean

    Returns number

readUIntLE

  • readUIntLE(offset: number, byteLength: number, noAssert?: boolean): number
  • Parameters

    • offset: number
    • byteLength: number
    • Optional noAssert: boolean

    Returns number

slice

  • slice(start?: number, end?: number): Buffer
  • Parameters

    • Optional start: number
    • Optional end: number

    Returns Buffer

toJSON

  • toJSON(): any
  • Returns any

toString

  • toString(encoding?: string, start?: number, end?: number): string
  • Parameters

    • Optional encoding: string
    • Optional start: number
    • Optional end: number

    Returns string

write

  • write(string: string, offset?: number, length?: number, encoding?: string): number
  • Parameters

    • string: string
    • Optional offset: number
    • Optional length: number
    • Optional encoding: string

    Returns number

writeDoubleBE

  • writeDoubleBE(value: number, offset: number, noAssert?: boolean): void
  • Parameters

    • value: number
    • offset: number
    • Optional noAssert: boolean

    Returns void

writeDoubleLE

  • writeDoubleLE(value: number, offset: number, noAssert?: boolean): void
  • Parameters

    • value: number
    • offset: number
    • Optional noAssert: boolean

    Returns void

writeFloatBE

  • writeFloatBE(value: number, offset: number, noAssert?: boolean): void
  • Parameters

    • value: number
    • offset: number
    • Optional noAssert: boolean

    Returns void

writeFloatLE

  • writeFloatLE(value: number, offset: number, noAssert?: boolean): void
  • Parameters

    • value: number
    • offset: number
    • Optional noAssert: boolean

    Returns void

writeInt16BE

  • writeInt16BE(value: number, offset: number, noAssert?: boolean): void
  • Parameters

    • value: number
    • offset: number
    • Optional noAssert: boolean

    Returns void

writeInt16LE

  • writeInt16LE(value: number, offset: number, noAssert?: boolean): void
  • Parameters

    • value: number
    • offset: number
    • Optional noAssert: boolean

    Returns void

writeInt32BE

  • writeInt32BE(value: number, offset: number, noAssert?: boolean): void
  • Parameters

    • value: number
    • offset: number
    • Optional noAssert: boolean

    Returns void

writeInt32LE

  • writeInt32LE(value: number, offset: number, noAssert?: boolean): void
  • Parameters

    • value: number
    • offset: number
    • Optional noAssert: boolean

    Returns void

writeInt8

  • writeInt8(value: number, offset: number, noAssert?: boolean): void
  • Parameters

    • value: number
    • offset: number
    • Optional noAssert: boolean

    Returns void

writeIntBE

  • writeIntBE(value: number, offset: number, byteLength: number, noAssert?: boolean): number
  • Parameters

    • value: number
    • offset: number
    • byteLength: number
    • Optional noAssert: boolean

    Returns number

writeIntLE

  • writeIntLE(value: number, offset: number, byteLength: number, noAssert?: boolean): number
  • Parameters

    • value: number
    • offset: number
    • byteLength: number
    • Optional noAssert: boolean

    Returns number

writeUInt16BE

  • writeUInt16BE(value: number, offset: number, noAssert?: boolean): void
  • Parameters

    • value: number
    • offset: number
    • Optional noAssert: boolean

    Returns void

writeUInt16LE

  • writeUInt16LE(value: number, offset: number, noAssert?: boolean): void
  • Parameters

    • value: number
    • offset: number
    • Optional noAssert: boolean

    Returns void

writeUInt32BE

  • writeUInt32BE(value: number, offset: number, noAssert?: boolean): void
  • Parameters

    • value: number
    • offset: number
    • Optional noAssert: boolean

    Returns void

writeUInt32LE

  • writeUInt32LE(value: number, offset: number, noAssert?: boolean): void
  • Parameters

    • value: number
    • offset: number
    • Optional noAssert: boolean

    Returns void

writeUInt8

  • writeUInt8(value: number, offset: number, noAssert?: boolean): void
  • Parameters

    • value: number
    • offset: number
    • Optional noAssert: boolean

    Returns void

writeUIntBE

  • writeUIntBE(value: number, offset: number, byteLength: number, noAssert?: boolean): number
  • Parameters

    • value: number
    • offset: number
    • byteLength: number
    • Optional noAssert: boolean

    Returns number

writeUIntLE

  • writeUIntLE(value: number, offset: number, byteLength: number, noAssert?: boolean): number
  • Parameters

    • value: number
    • offset: number
    • byteLength: number
    • Optional noAssert: boolean

    Returns number

NodeModule

NodeModule:

children

children: any[]

exports

exports: any

filename

filename: string

id

id: string

loaded

loaded: boolean

parent

parent: any

require

NodeRequire

  • __call(id: string): any
  • Parameters

    • id: string

    Returns any

cache

cache: any

extensions

extensions: any

main

main: any

resolve

  • resolve(id: string): string
  • Parameters

    • id: string

    Returns string

NodeRequireFunction

  • __call(id: string): any
  • Parameters

    • id: string

    Returns any

SetConstructor

SetConstructor:

WeakMapConstructor

WeakMapConstructor:

WeakSetConstructor

WeakSetConstructor:

SlowBuffer

SlowBuffer: object

Type declaration

  • constructor: function
    • new __type(str: string, encoding?: string): __type
    • new __type(size: number): __type
    • new __type(size: Uint8Array): __type
    • new __type(array: any[]): __type
    • Parameters

      • str: string
      • Optional encoding: string

      Returns __type

    • Parameters

      • size: number

      Returns __type

    • Parameters

      • size: Uint8Array

      Returns __type

    • Parameters

      • array: any[]

      Returns __type

  • prototype: Buffer
  • byteLength: function
    • byteLength(string: string, encoding?: string): number
    • Parameters

      • string: string
      • Optional encoding: string

      Returns number

  • concat: function
    • Parameters

      • list: Buffer[]
      • Optional totalLength: number

      Returns Buffer

  • isBuffer: function
    • isBuffer(obj: any): boolean
    • Parameters

      • obj: any

      Returns boolean

___dirname

___dirname: string

___filename

___filename: string

exports

exports: any

global

global: Global

module

module: NodeModule

process

process: Process
                                          *
              GLOBAL                      *
                                          *

require

require: NodeRequire

clearImmediate

  • clearImmediate(immediateId: any): void
  • Parameters

    • immediateId: any

    Returns void

clearInterval

  • clearInterval(intervalId: Timer): void
  • Parameters

    Returns void

clearTimeout

  • clearTimeout(timeoutId: Timer): void
  • Parameters

    Returns void

setImmediate

  • setImmediate(callback: function, ...args: any[]): any
  • Parameters

    • callback: function
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    • Rest ...args: any[]

    Returns any

setInterval

  • setInterval(callback: function, ms: number, ...args: any[]): Timer
  • Parameters

    • callback: function
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    • ms: number
    • Rest ...args: any[]

    Returns Timer

setTimeout

  • setTimeout(callback: function, ms: number, ...args: any[]): Timer
  • Parameters

    • callback: function
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    • ms: number
    • Rest ...args: any[]

    Returns Timer

"typings/main/ambient/source-map/index.d"

"typings/main/ambient/source-map/index.d":

"source-map"

"source-map":

SourceMap

SourceMap:

SourceMapConsumer

SourceMapConsumer:

constructor

GENERATED_ORDER

GENERATED_ORDER: number

ORIGINAL_ORDER

ORIGINAL_ORDER: number

eachMapping

  • eachMapping(callback: function, context?: any, order?: number): void
  • Parameters

    • callback: function
    • Optional context: any
    • Optional order: number

    Returns void

generatedPositionFor

  • Parameters

    Returns Position

originalPositionFor

  • Parameters

    Returns MappedPosition

sourceContentFor

  • sourceContentFor(source: string): string
  • Parameters

    • source: string

    Returns string

SourceMapGenerator

SourceMapGenerator:

constructor

addMapping

  • addMapping(mapping: Mapping): void
  • Parameters

    Returns void

applySourceMap

  • applySourceMap(sourceMapConsumer: SourceMapConsumer, sourceFile?: string, sourceMapPath?: string): void
  • Parameters

    • sourceMapConsumer: SourceMapConsumer
    • Optional sourceFile: string
    • Optional sourceMapPath: string

    Returns void

setSourceContent

  • setSourceContent(sourceFile: string, sourceContent: string): void
  • Parameters

    • sourceFile: string
    • sourceContent: string

    Returns void

toJSON

  • Returns RawSourceMap

toString

  • toString(): string
  • Returns string

fromSourceMap

SourceNode

SourceNode:

constructor

  • new SourceNode(): SourceNode
  • new SourceNode(line: number, column: number, source: string): SourceNode
  • new SourceNode(line: number, column: number, source: string, chunk?: string, name?: string): SourceNode
  • Returns SourceNode

  • Parameters

    • line: number
    • column: number
    • source: string

    Returns SourceNode

  • Parameters

    • line: number
    • column: number
    • source: string
    • Optional chunk: string
    • Optional name: string

    Returns SourceNode

add

  • Parameters

    • chunk: any

    Returns SourceNode

join

  • Parameters

    • sep: string

    Returns SourceNode

prepend

  • Parameters

    • chunk: any

    Returns SourceNode

replaceRight

  • replaceRight(pattern: string, replacement: string): SourceNode
  • Parameters

    • pattern: string
    • replacement: string

    Returns SourceNode

setSourceContent

  • setSourceContent(sourceFile: string, sourceContent: string): void
  • Parameters

    • sourceFile: string
    • sourceContent: string

    Returns void

toString

  • toString(): string
  • Returns string

toStringWithSourceMap

walk

  • walk(fn: function): void
  • Parameters

    Returns void

walkSourceContents

  • walkSourceContents(fn: function): void
  • Parameters

    • fn: function
        • (file: string, content: string): void
        • Parameters

          • file: string
          • content: string

          Returns void

    Returns void

fromStringWithSourceMap

  • Parameters

    Returns SourceNode

CodeWithSourceMap

CodeWithSourceMap:

code

code: string

map

MappedPosition

MappedPosition:

column

column: number

line

line: number

name

name: string

source

source: string

Mapping

Mapping:

generated

generated: Position

name

name: string

original

original: Position

source

source: string

MappingItem

MappingItem:

generatedColumn

generatedColumn: number

generatedLine

generatedLine: number

name

name: string

originalColumn

originalColumn: number

originalLine

originalLine: number

source

source: string

Position

Position:

column

column: number

line

line: number

RawSourceMap

RawSourceMap:

file

file: string

mappings

mappings: string

names

names: Array<string>

sourceRoot

sourceRoot: string

sources

sources: Array<string>

sourcesContent

sourcesContent: string[]

version

version: string

StartOfSourceMap

StartOfSourceMap:

file

file: string

sourceRoot

sourceRoot: string

"typings/main/ambient/vinyl/index.d"

"typings/main/ambient/vinyl/index.d":

"vinyl"

"vinyl":

File

File:

A virtual file format.

constructor

  • new File(options?: object): File
  • Parameters

    • Optional options: object
      • Optional base?: string

        Used for relative pathing. Typically where a glob starts.

      • Optional contents?: Buffer | ReadWriteStream

        File contents. Type: Buffer, Stream, or null

      • Optional cwd?: string

        Default: process.cwd()

      • Optional history?: string[]

        Path history. Has no effect if options.path is passed.

      • Optional path?: string

        Full path to the file.

      • Optional stat?: Stats

        The result of an fs.stat call. See fs.Stats for more information.

    Returns File

base

base: string

Used for relative pathing. Typically where a glob starts.

contents

Type: Buffer|Stream|null (Default: null)

cwd

cwd: string

Default: process.cwd()

path

path: string

Full path to the file.

relative

relative: string

Returns path.relative for the file base and file path. Example: var file = new File({ cwd: "/", base: "/test/", path: "/test/file.js" }); console.log(file.relative); // file.js

stat

stat: Stats

clone

  • clone(opts?: object): File
  • Returns a new File object with all attributes cloned. Custom attributes are deep-cloned.

    Parameters

    • Optional opts: object
      • Optional contents?: boolean

    Returns File

inspect

  • inspect(): string
  • Returns a pretty String interpretation of the File. Useful for console.log.

    Returns string

isBuffer

  • isBuffer(): boolean
  • Returns boolean

isDirectory

  • isDirectory(): boolean
  • Returns boolean

isNull

  • isNull(): boolean
  • Returns boolean

isStream

  • isStream(): boolean
  • Returns boolean

pipe

  • pipe<T>(stream: T, opts?: object): T
  • If file.contents is a Buffer, it will write it to the stream. If file.contents is a Stream, it will pipe it to the stream. If file.contents is null, it will do nothing.

    Type parameters

    Parameters

    • stream: T
    • Optional opts: object
      • Optional end?: boolean

        If false, the destination stream will not be ended (same as node core).

    Returns T

Legend

  • Module
  • Object literal
  • Variable
  • Function
  • Function with type parameter
  • Index signature
  • Type alias
  • Enumeration
  • Enumeration member
  • Property
  • Method
  • Interface
  • Interface with type parameter
  • Constructor
  • Property
  • Method
  • Index signature
  • Class
  • Class with type parameter
  • Constructor
  • Property
  • Method
  • Accessor
  • Index signature
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Protected property
  • Protected method
  • Protected accessor
  • Private property
  • Private method
  • Private accessor
  • Static property
  • Static method

Generated using TypeDoc